Skip to content

Commit

Permalink
Add docs (#2)
Browse files Browse the repository at this point in the history
* Update README.md

* Create LICENSE

* Update README.md
  • Loading branch information
Danny McCormick authored Jul 23, 2019
1 parent 3df79e0 commit bf4af63
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 1 deletion.
22 changes: 22 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -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.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,22 @@
# checkout
# 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)

2 comments on commit bf4af63

@Yousefaljboor
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LICENSE

@Yousefaljboor
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.