diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..50d2237 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,15 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [1.0.0] - 2023-01-23 + +### Added + +- Added all needed for the first release. See the README.md for a full description + of inputs and outputs. + +[1.0.0]: https://github.com/philss/rustler-precompiled-action/releases/tag/v1.0.0 diff --git a/README.md b/README.md index 40d17e5..a2fec4f 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,23 @@ It's **important to notice that this Action won't install Rust**. So you need to install it first. For that we recommend the [dtolnay/rust-toolchain] action that is well maintained. +## Usage + +```yaml +- name: Build the project + id: build + uses: philss/rustler-precompiled-action@v1 + with: + project-name: example + project-version: "0.5.2" + target: aarch64-unknown-linux-gnu + nif-version: "2.16" + use-cross: true + project-dir: "native/example" +``` + +See the example workflow below. + ## Inputs The following inputs are accepted: