Update README.md

2024-11-26 16:32:45 +08:00 · 2019-07-23 15:24:56 -04:00 · 2019-07-23 15:24:56 -04:00 · f17dfd3443
commit f17dfd3443
parent ba7b625c42
1 changed files with 37 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -1 +1,38 @@
 # upload-artifact
+
+This uploads artifacts from your build.
+
+# Usage
+
+See [action.yml](action.yml)
+
+Basic (upload current working directory):
+```yaml
+actions:
+- uses: actions/checkout@latest
+
+# Do stuff
+
+- uses: actions/upload-artifact@latest
+  with:
+    name: my-artifact
+```
+
+Upload specific directory:
+```yaml
+actions:
+- uses: actions/checkout@latest
+
+- run: mkdir -p path/to/artifact
+
+- run: echo hello > path/to/artifact/world.txt
+
+- uses: actions/upload-artifact@latest
+  with:
+    name: my-artifact
+    path: path/to/artifact
+```
+
+# License
+
+The scripts and documentation in this project are released under the [MIT License](LICENSE)