-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.md.tmpl
175 lines (111 loc) · 4.12 KB
/
README.md.tmpl
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
~~~~package_name~~~~
==========
<!---
This file is generated by ape-tmpl. Do not update manually.
--->
<!-- Badge Start -->
<a name="badges"></a>
[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]
[bd_repo_url]: https://github.com/realglobe-Inc/~~~~package_name~~~~
[bd_travis_url]: http://travis-ci.org/realglobe-Inc/~~~~package_name~~~~
[bd_travis_shield_url]: http://img.shields.io/travis/realglobe-Inc/~~~~package_name~~~~.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/realglobe-Inc/~~~~package_name~~~~
[bd_travis_com_shield_url]: https://api.travis-ci.com/realglobe-Inc/~~~~package_name~~~~.svg?token=
[bd_license_url]: https://github.com/realglobe-Inc/~~~~package_name~~~~/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/realglobe-Inc/~~~~package_name~~~~
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/realglobe-Inc/~~~~package_name~~~~.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/realglobe-Inc/~~~~package_name~~~~.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/realglobe-Inc/~~~~package_name~~~~
[bd_gemnasium_shield_url]: https://gemnasium.com/realglobe-Inc/~~~~package_name~~~~.svg
[bd_npm_url]: http://www.npmjs.org/package/~~~~package_name~~~~
[bd_npm_shield_url]: http://img.shields.io/npm/v/~~~~package_name~~~~.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
<!-- Badge End -->
<!-- Description Start -->
<a name="description"></a>
~~~~package_description~~~~
<!-- Description End -->
<!-- Overview Start -->
<a name="overview"></a>
<!-- Overview End -->
<!-- Sections Start -->
<a name="sections"></a>
<!-- Section from "doc/guides/00.Requirements.md.hbs" Start -->
<a name="section-doc-guides-00-requirements-md"></a>
Requirements
-----
<a href="https://nodejs.org">
<img src="https://realglobe-inc.github.io/sugos-assets/images/nodejs-banner.png"
alt="Node.js"
height="40"
style="height:40px"
/></a>
<a href="https://docs.npmjs.com/">
<img src="https://realglobe-inc.github.io/sugos-assets/images/npm-banner.png"
alt="NPM"
height="40"
style="height:40px"
/></a>
+ [Node.js ( >=6 )][node_download_url]
+ [npm ( >=4 )][npm_url]
[node_download_url]: https://nodejs.org/en/download/
[npm_url]: https://docs.npmjs.com/
<!-- Section from "doc/guides/00.Requirements.md.hbs" End -->
<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->
<a name="section-doc-guides-01-installation-md"></a>
Installation
-----
```bash
$ npm install ~~~~package_name~~~~ --save
```
<!-- Section from "doc/guides/01.Installation.md.hbs" End -->
<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->
<a name="section-doc-guides-02-usage-md"></a>
Usage
---------
Apply middleware to sg-server, which is internally use by sugo-cloud.
```javascript
/** This is an example to use ~~~~package_name~~~~ */
'use strict'
const sgServer = require('sg-server')
const server = sgServer({
middlewares: [
require('~~~~package_name~~~~')({
// Options
})
],
endpoints: {
/* ... */
}
})
server.listen(3000)
```
<!-- Section from "doc/guides/02.Usage.md.hbs" End -->
<!-- Section from "doc/guides/03.Signature.md.hbs" Start -->
<a name="section-doc-guides-03-signature-md"></a>
Signature
-------
#### ~~~~package_name@camelcase~~~~(options) -> function
~~~~package_description~~~~
##### Args
| Name | Type | Default | Description |
| --- | ---- | --- | --- |
| options | object | | Optional settings. |
<!-- Section from "doc/guides/03.Signature.md.hbs" End -->
<!-- Sections Start -->
<!-- LICENSE Start -->
<a name="license"></a>
License
-------
This software is released under the [Apache-2.0 License](https://github.com/realglobe-Inc/~~~~package_name~~~~/blob/master/LICENSE).
<!-- LICENSE End -->
<!-- Links Start -->
<a name="links"></a>
Links
------
+ [sugos][sugos_url]
[sugos_url]: https://github.com/realglobe-Inc/sugos
<!-- Links End -->