Permalink
Browse files

Added LICENSE and README

  • Loading branch information...
1 parent 9a1b18e commit a36b436ec712e263b2bb4dea56454a0e7a341a20 @OiNutter committed Apr 23, 2012
Showing with 51 additions and 0 deletions.
  1. +21 −0 LICENSE
  2. +30 −0 README.md
View
21 LICENSE
@@ -0,0 +1,21 @@
+Copyright (c) 2012 Will McKenzie http://oinutter.co.uk
+
+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
@@ -0,0 +1,30 @@
+Crawl
+=====
+
+Crawl is a port of the Ruby gem
+[Hike](https://github.com/sstephenson/hike) to Python. Crawl will scan
+through a list of given folders for a requested file. You can also
+configure it to just match any of a given list of extensions.
+
+While Crawl does work at the basic level, it is not yet a complete port
+of Hike, as it doesn't implement Hike's index caching for speedier
+responses, although I do intend to add that.
+
+Usage
+----
+
+```python
+import crawl
+trail = crawl.Trail()
+trail.add_paths('lib','foo','bar')
+trail.add_extensions('js','py')
+trail.find('blah')
+```
+
+License
+-------
+
+Copyright 2012 Will McKenzie
+
+Crawl is licensed under the MIT License, please see the LICENSE file for
+more details.

0 comments on commit a36b436

Please sign in to comment.