UNPKG

create-readme

Version:

Automatically creates README.md based on package.json and other existing files.

github.com/dbartholomae/create-readme

dbartholomae/create-readme

61 lines (43 loc) • 1.35 kB
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
# {{pkg.name}}{{#pkg.version}}@{{pkg.version}}{{/pkg.version}} {{#badges}} [![{{&name}}]({{&img}})]({{&url}}) {{/badges}} {{&description}} {{#usage}} ## Usage {{&usage.description}} {{#usage.examples}} ```{{&lang}} {{&content}} ``` {{/usage.examples}}{{/usage}} ## Installation {{^pkg.private}} Download node at [nodejs.org](http://nodejs.org) and install it, if you haven't already. ```sh {{#pkg.preferGlobal}} npm install {{&pkg.name}} --global {{/pkg.preferGlobal}} {{^pkg.preferGlobal}} npm install {{&pkg.name}} --save {{/pkg.preferGlobal}} ``` {{/pkg.private}} {{#install.modules}}This package is provided in these module formats: {{#install.modules.names}} - {{&name}}{{/install.modules.names}} {{/install.modules}} {{#install.unpkg}}The module is available via [UNPKG](https://unpkg.com/) at [https://unpkg.com/{{pkg.name}}](https://unpkg.com/{{&pkg.name}}){{/install.unpkg}} {{#docs}} ## Documentation You can find a documentation [here]({{&docs}}). {{/docs}} ## Dependencies {{#dependencies.dep}}- [{{&name}}]({{&url}}): {{&desc}} {{/dependencies.dep}}{{^dependencies.dep}}None{{/dependencies.dep}} ## Dev Dependencies {{#dependencies.dev}}- [{{&name}}]({{&url}}): {{&desc}} {{/dependencies.dev}}{{^dependencies.dev}}None{{/dependencies.dev}} {{#license}} ## License [{{&license.name}}]({{&license.file}}) {{/license}}