An open API service indexing awesome lists of open source software.

https://github.com/rootstrap/js-library-template


https://github.com/rootstrap/js-library-template

Last synced: 28 days ago
JSON representation

Awesome Lists containing this project

README

          

# @rootstrap/your-library-name

[![Maintainability](https://api.codeclimate.com/v1/badges/a878b4be647cd2a9582c/maintainability)](https://codeclimate.com/github/rootstrap/your-library-name/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/a878b4be647cd2a9582c/test_coverage)](https://codeclimate.com/github/rootstrap/your-library-name/test_coverage)

[Description]
Add the name and description of the library.
**IMPORTANT:** replace all the instances of "your-library-name" with the actual library name or remove if doesn't apply

## Demo

[In this section, you should include some images/gifs of how the library looks like.
Also if the library has some demo you can add the steps for emulating this.]

## Installation

```
yarn add @rootstrap/your-library-name
```
or
```
npm install @rootstrap/your-library-name --save
```

## Usage

[Please add here at least some simple examples of how to use the library.]

## Contributing

If you have an idea that could make this library better we would love to hear it. Please take a look at our [Contributing Guidelines](CONTRIBUTING.md) to get to know the rules and how to get started with your contribution.

## License

**@rootstrap/your-library-name** is available under the MIT license. See [LICENSE](LICENSE.md) file for more info.

## Credits

**@rootstrap/your-library-name** is maintained by [Rootstrap](http://www.rootstrap.com) with the help of our [contributors](https://github.com/rootstrap/your-library-name/contributors).

[](http://www.rootstrap.com)