From 3cb6230fed52612c56917856088ba639070435f7 Mon Sep 17 00:00:00 2001 From: Craig Paul Date: Tue, 20 Nov 2018 10:34:00 -0600 Subject: [PATCH] Adds install instructions, changelog link and testing instructions to readme --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index 226c5d4..5da2c6f 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,34 @@ [![Coverage Status][ico-codecov]][link-codecov] [![npm downloads][ico-downloads]][link-downloads] +## Install + +Using npm: + +```bash +$ npm install coconut-open-api-js +``` + +Using yarn: + +```bash +$ yarn add coconut-open-api-js +``` + +## Change log + +Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. + +## Testing + +```bash +$ yarn run test +``` + +## License + +The MIT License (MIT). Please see [License File](LICENSE.md) for more information. + [ico-version]: https://img.shields.io/npm/v/coconut-open-api-js.svg?style=flat-square [ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square [ico-travis]: https://img.shields.io/travis/coconutcalendar/coconut-open-api-js/master.svg?style=flat-square