Skip to content

Commit f269e3b

Browse files
committed
updated README and LICENSE
for v1.0.0
1 parent 47a1d1a commit f269e3b

File tree

3 files changed

+41
-13
lines changed

3 files changed

+41
-13
lines changed

LICENSE

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
(The MIT License)
2+
3+
Copyright (c) 2014 Charles Julian Knight
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
6+
7+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8+
9+
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 OR COPYRIGHT HOLDERS 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.

README.md

+30-11
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,42 @@
11
swank
22
=====
33

4-
Stupid simple static webserver I whipped up in 30 minutes. If you want to test local static
5-
files (HTML, JS, CSS), simply run swank.
4+
The stupid simple static webserver. If you want to test local static
5+
files (HTML, JS, CSS), simply run `swank`. It's even got livereload
6+
and introspected tunnels built in.
67

78
Install
89
-------
910
npm install -g swank
1011

11-
Depends on connect.
12-
13-
ngrok
12+
Usage
1413
-----
1514

16-
`swank` now has optional [ngrok](https://www.npmjs.org/package/ngrok) support. Just use the `--ngrok` flag
17-
to expose your local machine to the wider internet.
15+
swank [[--ngrok | -n]] [[--watch | -w]] [[--no-log]] [[--port | -p PORT]] [[ [[--path | -d]] root_directory]]
1816

19-
Usage
20-
-----
21-
swank [[--ngrok]] [[--port=PORT]] [[root_directory]]
17+
--ngrok: pipe your server through [ngrok's](https://www.npmjs.org/package/ngrok) local tunnel
18+
--watch: a watch+livereload server. Includes `livereload.js` in HTML files, starts the livereload server, and watches your
19+
directory, causing a reload when files change
20+
--no-log: disable logging of requests
21+
--port: specify the local port to use. Defaults to $PORT or 8000
22+
--path: the path to the root directory of the server. Defaults to the current working directory
2223

23-
Defaults to using current working directory and port 8000.
24+
25+
You can also use it as a module, if you can think of any reason to.
26+
27+
```javascript
28+
var defaults = {
29+
path: '.',
30+
port: 8000,
31+
help: false,
32+
ngrok: false,
33+
watch: false,
34+
log: true,
35+
liveReload: {}
36+
};
37+
require('swank')(defaults);
38+
```
39+
40+
LICENSE
41+
-------
42+
[MIT](LICENSE)

package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "swank",
3-
"version": "0.0.7",
3+
"version": "1.0.0",
44
"description": "Host static files in the current directory with one command.",
55
"main": "swank.js",
66
"dependencies": {
@@ -21,7 +21,7 @@
2121
"test": "node_modules/.bin/mocha test/test.js"
2222
},
2323
"author": "[email protected]",
24-
"license": "WTFPL",
24+
"license": "MIT",
2525
"preferGlobal": "true",
2626
"bin": {
2727
"swank": "./bin/swank"

0 commit comments

Comments
 (0)