From 6b71935c437479e5c49db23356f45cff7c8532e9 Mon Sep 17 00:00:00 2001 From: Danny McCormick Date: Tue, 23 Jul 2019 15:20:07 -0400 Subject: [PATCH] Update README.md --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 919b00e..0e105fe 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@latest +- uses: actions/setup-node@latest + 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)