diff --git a/README.md b/README.md new file mode 100644 index 0000000..f0b5ab1 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# ts-gems + +[![NPM Version][npm-image]][npm-url] +[![NPM Downloads][downloads-image]][downloads-url] +[![CI Tests][ci-test-image]][ci-test-url] + +## Installation + +```bash +$ npm install ts-gems --save +``` +## Node Compatibility +- node >= 16.x +## License +ts-gems is available under [MIT](LICENSE) license. + +[npm-image]: https://img.shields.io/npm/v/ts-gems +[npm-url]: https://npmjs.org/package/ts-gems +[ci-test-image]: https://github.com/panates/ts-gems/actions/workflows/test.yml/badge.svg +[ci-test-url]: https://github.com/panates/ts-gems/actions/workflows/test.yml +[coveralls-image]: https://img.shields.io/coveralls/panates/ts-gems/master.svg +[coveralls-url]: https://coveralls.io/r/panates/ts-gems +[downloads-image]: https://img.shields.io/npm/dm/ts-gems.svg +[downloads-url]: https://npmjs.org/package/ts-gems +[gitter-image]: https://badges.gitter.im/panates/ts-gems.svg +[gitter-url]: https://gitter.im/panates/ts-gems?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge +[dependencies-image]: https://david-dm.org/panates/ts-gems/status.svg +[dependencies-url]:https://david-dm.org/panates/ts-gems +[devdependencies-image]: https://david-dm.org/panates/ts-gems/dev-status.svg +[devdependencies-url]:https://david-dm.org/panates/ts-gems?type=dev +[quality-image]: http://npm.packagequality.com/shield/ts-gems.png +[quality-url]: http://packagequality.com/#?package=ts-gems