Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Updated README

  • Loading branch information...
commit 2f9f8545f91ca865f6840d9f6f7a713647b546b8 1 parent edd0898
Will McKenzie authored
Showing with 10 additions and 6 deletions.
  1. +10 −6 README.md
16 README.md
View
@@ -5,12 +5,8 @@ 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.
+through a list of given folders for a requested file. You can also specify
+a list of possible extensions and aliases for those extensions.
Install
-------
@@ -27,6 +23,7 @@ import crawl
trail = crawl.Crawl()
trail.append_paths('lib','foo','bar')
trail.append_extensions('js','py')
+trail.alias_extension('.coffee','.js')
trail.find('blah')
```
@@ -52,6 +49,13 @@ Run the following from the command line to run all tests:
$ nosetests
```
+Credits
+-------
+
+Huge amounts of credit to Sam Stephenson(@sstephenson) and Josh Peek(@josh) for all their work on the original
+[Hike](https://github.com/sstephenson/hike) gem. I have basically just rewritten their code and tests in python, tweaking where necessary to
+make things more 'pythonic' (I hope).
+
License
-------
Please sign in to comment.
Something went wrong with that request. Please try again.