Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

modernize readme, add license

  • Loading branch information...
commit 08d166f10c0f3306a83065d1866bc89c59c378c7 1 parent 2402899
@substack authored
Showing with 26 additions and 15 deletions.
  1. +18 −0 LICENSE
  2. +1 −2  package.json
  3. +7 −13 README.markdown → readme.markdown
View
18 LICENSE
@@ -0,0 +1,18 @@
+This software is released under the MIT license:
+
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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.
View
3  package.json
@@ -36,6 +36,5 @@
"email" : "mail@substack.net",
"url" : "http://substack.net"
},
- "license" : "MIT/X11",
- "engine" : { "node" : ">=0.4" }
+ "license" : "MIT"
}
View
20 README.markdown → readme.markdown
@@ -1,5 +1,4 @@
-archy
-=====
+# archy
Render nested hierarchies `npm ls` style with unicode pipes.
@@ -7,8 +6,7 @@ Render nested hierarchies `npm ls` style with unicode pipes.
[![build status](https://secure.travis-ci.org/substack/node-archy.png)](http://travis-ci.org/substack/node-archy)
-example
-=======
+# example
``` js
var archy = require('archy');
@@ -52,13 +50,11 @@ beep
time!
```
-methods
-=======
+# methods
var archy = require('archy')
-archy(obj, prefix='', opts={})
-------------------------------
+## archy(obj, prefix='', opts={})
Return a string representation of `obj` with unicode pipe characters like how
`npm ls` looks.
@@ -79,8 +75,7 @@ with the current prefix.
To disable unicode results in favor of all-ansi output set `opts.unicode` to
`false`.
-install
-=======
+# install
With [npm](http://npmjs.org) do:
@@ -88,7 +83,6 @@ With [npm](http://npmjs.org) do:
npm install archy
```
-license
-=======
+# license
-MIT/X11
+MIT

0 comments on commit 08d166f

Please sign in to comment.
Something went wrong with that request. Please try again.