From 059550de260b5f61d370a787e2d8fd5754ad2fa9 Mon Sep 17 00:00:00 2001
From: David Tolnay <dtolnay@gmail.com>
Date: Thu, 7 Oct 2021 22:51:26 -0400
Subject: [PATCH] Add readme

---
 README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f45013e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,46 @@
+# Fast `cargo install` action
+
+This GitHub Action installs a Rust crate using precompiled signed binaries built
+on GitHub and hosted as GitHub release artifacts.
+
+## Example workflow
+
+```yaml
+name: test suite
+on: [push, pull_request]
+
+jobs:
+  expand:
+    name: cargo expand
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: dtolnay/install@master
+        with:
+          crate: cargo-expand
+      - run: cargo expand --help
+```
+
+## Inputs
+
+| Name    | Required | Description                                  |
+| ------- | :------: | -------------------------------------------- |
+| `crate` | ✓        | Name of crate as published to crates.io      |
+| `bin`   |          | Name of binary; default = same as crate name |
+
+## Security considerations
+
+Check the `.github/workflows` directory of this repo for the GitHub Actions
+logic which compiles, signs, and publishes each binary.
+
+This Action downloads both the binary executable and its signature. The
+signature is verified using gpg and the public key available in
+`signing-key.asc`. The corresponding private key is provided to this repo's
+build jobs as a GitHub secret.
+
+## License
+
+The scripts and documentation in this project are released under the [MIT
+License].
+
+[MIT License]: LICENSE