From c4c0fc0de0c8196db132321ad661138480474896 Mon Sep 17 00:00:00 2001 From: Danny McCormick Date: Tue, 23 Jul 2019 15:32:03 -0400 Subject: Add docs (#2) * Update README.md * Create LICENSE * Update README.md --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) (limited to 'README.md') 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) -- cgit v1.2.3