Skip to content

Commit eca31ce

Browse files
committed
Initial commit
0 parents  commit eca31ce

File tree

7 files changed

+120
-0
lines changed

7 files changed

+120
-0
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
node_modules

.travis.yml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
language: node_js
2+
node_js:
3+
- node
4+
deploy:
5+
provider: npm
6+
7+
on:
8+
node: node
9+
tags: true
10+
branch: master
11+
repo: wmhilton/update-doc
12+
api_key:
13+
secure: jGWMAxSqlwXU995o3Wi2PUixAY+mBSM7hrsmnfZfEiPWZfutWHaGxM78HVgDG2qjcatp4gPoAM5NspekgGgINOgMjs9JDFJBuHVYP5oqeuQ4niAB81sO/ogszvn5p948qPMw/3GkQQX8IyRWolnGxqvoVkcvBywzX9B4R+eUm4Mb/czeMxB01U5vPuTxyR2GNs2L296+EeB33xKQG/ddv4wDdqZQnaBxicbe7df10Uque7HUANDMCBh/FchZnyMXwPflUO0woWbhm67U9kV7fdHy89rmF/SZ5Ne1ClhapIvPW2nVk59PDDwFHR8vUdyNeyJJQfI8cK9NnrNif7tvhx82x3ebph6PydQW6+34pl0xPrAP9NVg+xEvI6zvOPMIrMc4E10zNY2ifuTV43ODUZZnZMIPfK0r/lv11AmpAVEKrsg2nxk7tMIudYndrIHRcC1N+EOx3VBfK8CNpcLvY46wp+cKZF//Vz4LFmZLAAVQpIGbfHkxCCzkPXlZdf8UKf1+/Ck3O8HTUzOslw+Hn8H9EPd5Br10yoUEZhCnLJIpmo8KI39cZEQVtivHJi37ifyljOVrUtvU6BwllgY8bxVanP9OSSNb2+ItqNbb+KaQBHb/hs7SSPxyJJq+Uc0QIxp24T4WPyR0FNYO40BQPO7YfMFs4T6mmbejkJQ6LLU=

LICENSE.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<!-- LICENSEFILE/ -->
2+
3+
<h1>License</h1>
4+
5+
Unless stated otherwise all works are:
6+
7+
<ul><li>Copyright &copy; William Hilton</li></ul>
8+
9+
and licensed under:
10+
11+
<ul><li><a href="http://spdx.org/licenses/Unlicense.html">The Unlicense</a></li></ul>
12+
13+
<h2>This is free and unencumbered software released into the public domain.</h2>
14+
15+
<pre>
16+
Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
17+
18+
In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and
19+
successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.
20+
21+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22+
23+
For more information, please refer to <http://unlicense.org/>
24+
</pre>
25+
26+
<!-- /LICENSEFILE -->

README.md

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
<!-- TITLE/ -->
2+
3+
<h1>update-doc</h1>
4+
5+
<!-- /TITLE -->
6+
7+
8+
<!-- BADGES/ -->
9+
10+
11+
12+
<!-- /BADGES -->
13+
14+
15+
<!-- DESCRIPTION/ -->
16+
17+
Quickly generate or update your project's README, LICENSE, and so on
18+
19+
<!-- /DESCRIPTION -->
20+
21+
22+
## Installation
23+
24+
Download node at [nodejs.org](http://nodejs.org) and install it, if you haven't already.
25+
26+
Then in the terminal, run:
27+
28+
```sh
29+
npm install update-doc --save
30+
```
31+
32+
## Tests
33+
34+
First clone this repository to get the source code. Then in the topmost repo
35+
directory run:
36+
37+
```sh
38+
npm install
39+
npm test
40+
```
41+
42+
<!-- LICENSE/ -->
43+
44+
<h2>License</h2>
45+
46+
Unless stated otherwise all works are:
47+
48+
<ul><li>Copyright &copy; William Hilton</li></ul>
49+
50+
and licensed under:
51+
52+
<ul><li><a href="http://spdx.org/licenses/Unlicense.html">The Unlicense</a></li></ul>
53+
54+
<!-- /LICENSE -->
55+
56+
57+
_Parts of this file are based on [package-json-to-readme](https://github.com/zeke/package-json-to-readme)_
58+
59+
_README.md (and other files) are maintained using [mos](https://github.com/mosjs/mos) and [projectz](https://github.com/bevry/projectz)_

package.json

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"name": "update-doc",
3+
"version": "0.0.0",
4+
"description": "Quickly generate or update your project's README, LICENSE, and so on",
5+
"main": "update-doc.js",
6+
"scripts": {
7+
"docs": "projectz && mos"
8+
},
9+
"keywords": [],
10+
"author": "William Hilton <[email protected]>",
11+
"license": "Unlicense",
12+
"maintainers": [],
13+
"contributors": []
14+
}

test/update-doc.test.js

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
import test from 'ava'
2+
3+
test('foo', t => {
4+
t.is(2+2, 5)
5+
})

update-doc.js

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
'use strict'
2+

0 commit comments

Comments
 (0)