From bf4af63534d79cb0712d8c86d8f2404844fa5a79 Mon Sep 17 00:00:00 2001 From: Danny McCormick Date: Tue, 23 Jul 2019 15:32:03 -0400 Subject: [PATCH] Add docs (#2) * Update README.md * Create LICENSE * Update README.md --- LICENSE | 22 ++++++++++++++++++++++ README.md | 23 ++++++++++++++++++++++- 2 files changed, 44 insertions(+), 1 deletion(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a67dca8 --- /dev/null +++ b/LICENSE @@ -0,0 +1,22 @@ + +The MIT License (MIT) + +Copyright (c) 2018 GitHub, Inc. and contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. 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)