|
| 1 | +# core-components |
| 2 | + |
| 3 | +core React components for Travi.org sites |
| 4 | + |
| 5 | +<!-- status badges --> |
| 6 | +[![Build Status][ci-badge]][ci-link] |
| 7 | + |
| 8 | +## Usage |
| 9 | + |
| 10 | +<!-- consumer badges --> |
| 11 | +[![npm][npm-badge]][npm-link] |
| 12 | +[![Try @travi/core-components on RunKit][runkit-badge]][runkit-link] |
| 13 | +[![MIT license][license-badge]][license-link] |
| 14 | + |
| 15 | +### Installation |
| 16 | + |
| 17 | +```sh |
| 18 | +$ npm install @travi/travi.org-core-components --save-prod |
| 19 | +``` |
| 20 | + |
| 21 | +## Contributing |
| 22 | + |
| 23 | +<!-- contribution badges --> |
| 24 | +[![Conventional Commits][commit-convention-badge]][commit-convention-link] |
| 25 | +[![Commitizen friendly][commitizen-badge]][commitizen-link] |
| 26 | +[![semantic-release][semantic-release-badge]][semantic-release-link] |
| 27 | +[![PRs Welcome][PRs-badge]][PRs-link] |
| 28 | + |
| 29 | +### Dependencies |
| 30 | + |
| 31 | +```sh |
| 32 | +$ nvm install |
| 33 | +$ npm install |
| 34 | +``` |
| 35 | + |
| 36 | +### Verification |
| 37 | + |
| 38 | +```sh |
| 39 | +$ npm test |
| 40 | +``` |
| 41 | + |
| 42 | +[npm-link]: https://www.npmjs.com/package/@travi/travi.org-core-components |
| 43 | +[npm-badge]: https://img.shields.io/npm/v/@travi/travi.org-core-components.svg |
| 44 | +[runkit-link]: https://npm.runkit.com/@travi/travi.org-core-components |
| 45 | +[runkit-badge]: https://badge.runkitcdn.com/@travi/travi.org-core-components.svg |
| 46 | +[license-link]: LICENSE |
| 47 | +[license-badge]: https://img.shields.io/github/license/travi-org/core-components.svg |
| 48 | +[ci-link]: https://travis-ci.com/travi-org/core-components |
| 49 | +[ci-badge]: https://img.shields.io/travis/com/travi-org/core-components/master.svg |
| 50 | +[commit-convention-link]: https://conventionalcommits.org |
| 51 | +[commit-convention-badge]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg |
| 52 | +[commitizen-link]: http://commitizen.github.io/cz-cli/ |
| 53 | +[commitizen-badge]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg |
| 54 | +[semantic-release-link]: https://github.com/semantic-release/semantic-release |
| 55 | +[semantic-release-badge]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg |
| 56 | +[PRs-link]: http://makeapullrequest.com |
| 57 | +[PRs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg |
0 commit comments