Read-only mirror — the public repositories of the Forgejo instance, refreshed every 10 minutes. The live instance (fg.dieschoenewolke.de) is reachable only over the VPN; clone here with https://git.dieschoenewolke.de/git/<owner>/<repo>.git.
summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 22 insertions, 1 deletions
diff --git a/README.md b/README.md
index 919b00e..c982e19 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,22 @@
-# checkout \ No newline at end of file
+# checkout
+
+This action checks out your repository so that your workflow operates from the root of the repository
+
+# Usage
+
+See [action.yml](action.yml)
+
+Basic:
+```yaml
+actions:
+- uses: actions/checkout@master
+- uses: actions/setup-node@master
+ with:
+ version: 10.x
+- run: npm install
+- run: npm test
+```
+
+# License
+
+The scripts and documentation in this project are released under the [MIT License](LICENSE)