README_md

My Project Name
==============================================
### The description of my library

[![Cross-Platform Compatibility](https://my-website.com/img/badges/os-badges.svg)](https://github.com/MyGitHubOrg/my-repo-name/actions)
[![Build Status](https://github.com/MyGitHubOrg/my-repo-name/workflows/CI-CD/badge.svg)](https://github.com/MyGitHubOrg/my-repo-name/actions)

[![Coverage Status](https://coveralls.io/repos/github/MyGitHubOrg/my-repo-name/badge.svg?branch=master)](https://coveralls.io/github/MyGitHubOrg/my-repo-name)
[![Dependencies](https://david-dm.org/MyGitHubOrg/my-repo-name.svg)](https://david-dm.org/MyGitHubOrg/my-repo-name)

[![npm](https://img.shields.io/npm/v/@my-npm-scope/my-package-name.svg)](https://www.npmjs.com/package/@my-npm-scope/my-package-name)
[![License](https://img.shields.io/npm/l/@my-npm-scope/my-package-name.svg)](LICENSE)
[![Buy us a tree](https://img.shields.io/badge/Treeware-%F0%9F%8C%B3-lightgreen)](https://plant.treeware.earth/MyGitHubOrg/my-repo-name)



Features
--------------------------
- Feature 1
- Feature 2
- Feature 3



Example
--------------------------

```javascript
import myLibrary from "@my-npm-scope/my-package-name";

// TODO: Add a usage example here
```



Installation
--------------------------
You can install My Project Name via [npm](https://docs.npmjs.com/about-npm/).

```bash
npm install @my-npm-scope/my-package-name
```



Usage
--------------------------
TODO: Document the library's API and CLI usage



Contributing
--------------------------
Contributions, enhancements, and bug-fixes are welcome!  [Open an issue](https://github.com/MyGitHubOrg/my-repo-name/issues) on GitHub and [submit a pull request](https://github.com/MyGitHubOrg/my-repo-name/pulls).

#### Building
To build the project locally on your computer:

1. __Clone this repo__<br>
`git clone https://github.com/MyGitHubOrg/my-repo-name.git`

2. __Install dependencies__<br>
`npm install`

3. __Build the code__<br>
`npm run build`

4. __Run the tests__<br>
`npm test`



License
--------------------------
My Project Name is 100% free and open-source, under the [MIT license](LICENSE). Use it however you want.

This package is [Treeware](http://treeware.earth). If you use it in production, then we ask that you [**buy the world a tree**](https://plant.treeware.earth/MyGitHubOrg/my-repo-name) to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.



Big Thanks To
--------------------------
Thanks to these awesome companies for their support of Open Source developers ❤

[![Travis CI](https://my-website.com/img/badges/travis-ci.svg)](https://travis-ci.com)
[![SauceLabs](https://my-website.com/img/badges/sauce-labs.svg)](https://saucelabs.com)
[![Coveralls](https://my-website.com/img/badges/coveralls.svg)](https://coveralls.io)