generated from JS-DevTools/template-node-typescript
-
Notifications
You must be signed in to change notification settings - Fork 1
/
README_md
105 lines (64 loc) · 3.89 KB
/
README_md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
My Project Name
==============================================
### The description of my library
[](https://www.npmjs.com/package/@my-npm-scope/my-package-name)
[](LICENSE)
[](https://plant.treeware.earth/MyGitHubOrg/my-repo-name)
[](https://github.com/MyGitHubOrg/my-repo-name/actions)
[](https://coveralls.io/github/MyGitHubOrg/my-repo-name)
[](https://david-dm.org/MyGitHubOrg/my-repo-name)
[](https://github.com/MyGitHubOrg/my-repo-name/actions)
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
--------------------------
When using My Project Name in Node.js apps, you'll probably want to use **CommonJS** syntax:
```javascript
const myLibrary = require("@my-npm-scope/my-package-name");
```
When using a transpiler such as [Babel](https://babeljs.io/) or [TypeScript](https://www.typescriptlang.org/), or a bundler such as [Webpack](https://webpack.js.org/) or [Rollup](https://rollupjs.org/), you can use **ECMAScript modules** syntax instead:
```javascript
import myLibrary from "@my-npm-scope/my-package-name";
```
Browser support
--------------------------
My Project Name supports recent versions of every major web browser. Older browsers may require [Babel](https://babeljs.io/) and/or [polyfills](https://babeljs.io/docs/en/next/babel-polyfill).
To use My Project Name in a browser, you'll need to use a bundling tool such as [Webpack](https://webpack.js.org/), [Rollup](https://rollupjs.org/), [Parcel](https://parceljs.org/), or [Browserify](http://browserify.org/). Some bundlers may require a bit of configuration, such as setting `browser: true` in [rollup-plugin-resolve](https://github.com/rollup/rollup-plugin-node-resolve).
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 ❤
[](https://travis-ci.com)
[](https://saucelabs.com)
[](https://coveralls.io)