Skip to content

Commit e622763

Browse files
author
Guillaume Martigny
committed
Extends readme
1 parent c8bfebd commit e622763

File tree

3 files changed

+35
-1
lines changed

3 files changed

+35
-1
lines changed

documentations.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Documentations
2+
File renamed without changes.

readme.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,48 @@ Base repo for JS project
33

44
## Installation
55

6+
npm install boiler.js
7+
68

79
## Usage
810

11+
Once installed, add it to your project with common.js or ES6 syntax :
12+
13+
```js
14+
const Boiler = require("boiler.js");
15+
// or
16+
import Boiler from "boiler.js";
17+
```
18+
19+
Then, you can start to use it on your code :
20+
21+
```js
22+
const boiler = new Boiler();
23+
```
24+
25+
Since today's web browser don't support module requirements yet, you need to use a bundler like [webpack](https://webpack.js.org/) or [browserify](http://browserify.org/).
26+
927

1028
## CDN
1129

30+
If you want to go old-school, you can fetch the script with [unpkg](https://unpkg.com/) or [jsdelivr](https://www.jsdelivr.com/).
31+
32+
```html
33+
<script src="https://unpkg.com/boiler.js"></script>
34+
<!-- or -->
35+
<script src="https://cdn.jsdelivr.net/npm/boiler.js"></script>
36+
37+
<script>
38+
console.log(new Boiler());
39+
</script>
40+
```
41+
1242

1343
## Documentation
1444

45+
Go see the [full documentation](documentations.md) or [some examples](https://gmartigny.github.io/boiler).
46+
1547

1648
## License
1749

18-
[MIT](LICENSE )
50+
[MIT](license)

0 commit comments

Comments
 (0)