readmify/template.tpl at master · takashi/readmify · GitHub

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
# <%= name %>
<% if(travisUrl){ %>[![Build Status](<%= travisUrl.replace('//', '//secure.') %>.png?branch=master)](<%= travisUrl %>)<% } %>

<%= description %>

<% if(scripts.build){ %>## Build

```shell
<% if(repository) { %>git clone <%= repository.url %><% } %>
cd ./<%= name %>
npm install
npm run build
```
Inside, you will run with `<%= scripts.build %>`<% } %>
<% if(scripts.test){  %>## Test

```shell
npm install
npm run test
```
Inside, you will run with `<%= scripts.test %>`<% } %>

## Dependencies
<% for(d in dependencies){ %>
- <%= d %><% } %>

## Contributing

Fork, fix, then send me a pull request.
<% if(bugs){  %>If your find any problem on <%= name %>, [please open issue](<%= bugs.url %>)<% } %>

## License

<% if(license) { %><%= license %><% } %>