Skip to content

Commit

Permalink
clean up readme and license
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewrk committed Oct 12, 2014
1 parent 3e92c38 commit a847a93
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 27 deletions.
34 changes: 20 additions & 14 deletions LICENSE
@@ -1,18 +1,24 @@
This software is released under the MIT license:
The MIT License (Expat)

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,
Copyright (c) 2014 Andrew Kelley
Copyright (c) 2014 James Halliday

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 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.
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.
30 changes: 22 additions & 8 deletions readme.markdown → README.md
Expand Up @@ -2,7 +2,25 @@

Recursively walk directory trees. Think `/usr/bin/find`.

[![build status](https://secure.travis-ci.org/substack/node-findit.png)](http://travis-ci.org/substack/node-findit)
[![build status](https://secure.travis-ci.org/andrewrk/node-findit.png)](http://travis-ci.org/andrewrk/node-findit)

## Why the fork?

There is a [pull request](https://github.com/substack/node-findit/pull/34) to
merge this project back into findit.

The pull request fixes every open issue in findit, and it completely rewrites
the code from the ground up.

It also adds an additional feature regarding symlinks.

I would love for substack to merge the pull request, but realistically it might
not happen, and this code is objectively cleaner, more robust, and fixes
several critical issues.

I recommend depending on this module rather than the original findit. If the
pull request is merged, however, I will add a deprecation notice to this module
and happily hand the maintainer hat back to substack.

# example

Expand All @@ -28,10 +46,10 @@ finder.on('link', function (link, stat) {
# methods

``` js
var find = require('findit')
var findit = require('findit2')
```

## var finder = find(basedir, opts)
## var finder = findit(basedir, opts)

Return an event emitter `finder` that performs a recursive walk starting at
`basedir`.
Expand Down Expand Up @@ -106,9 +124,5 @@ You can always get the source of the error by checking `err.path`.
With [npm](https://npmjs.org) do:

```
npm install findit
npm install findit2
```

# license

MIT
6 changes: 1 addition & 5 deletions package.json
Expand Up @@ -22,10 +22,6 @@
"tree",
"traversal"
],
"author": {
"name": "James Halliday",
"email": "mail@substack.net",
"url": "http://substack.net"
},
"author": "Andrew Kelley <superjoe30@gmail.com>",
"license": "MIT"
}

0 comments on commit a847a93

Please sign in to comment.