From c6705d21ab046bb807bbd3163dfb553d91d36348 Mon Sep 17 00:00:00 2001 From: Gleb Bahmutov Date: Thu, 14 Nov 2019 23:41:58 -0500 Subject: [PATCH] fix: add example to readme --- README.md | 59 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 58 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ec29285..a5ecc9a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,62 @@ -# npm-install +# npm-install [![semantic-release][semantic-image] ][semantic-url] > GitHub Action for install npm dependencies with caching without any configuration See [bahmutov/npm-install-action-example](https://github.com/bahmutov/npm-install-action-example). + +If you use `npm ci` or `yarn --frozen-lockfile` on CI to install NPM dependencies - this Action is for you. Simply use it, and your NPM modules will be installed and the folder `~/.npm` or `~/.cache/yarn` will be cached. Typical use: + +```yml +name: main +on: [push] +jobs: + build-and-test: + runs-on: ubuntu-latest + name: Build and test + steps: + - name: Checkout + uses: actions/checkout@v1 + - uses: bahmutov/npm-install@v1 + - run: npm test +``` + +### Small print + +Author: Gleb Bahmutov <gleb.bahmutov@gmail.com> © 2019 + +- [@bahmutov](https://twitter.com/bahmutov) +- [glebbahmutov.com](https://glebbahmutov.com) +- [blog](https://glebbahmutov.com/blog) + +License: MIT - do anything with the code, but don't blame me if it does not work. + +Support: if you find any problems with this module, email / tweet / +[open issue](https://github.com/bahmutov/npm-install/issues) on Github + +## MIT License + +Copyright (c) 2019 Gleb Bahmutov <gleb.bahmutov@gmail.com> + +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. + +[semantic-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg +[semantic-url]: https://github.com/semantic-release/semantic-release