Read Me

search version 1.0
==================

What is search?
-----------

search is a simple python script for doing a regex search [and replace] on 
multiple text files. 

How to use search
-----------------

The syntax for invoking search is:

~$ search <pattern> [files ...] [directories ...]

If no file or directory is specified, search will default to search all text
files in the current directory. So, for instance, if you wanted to search all
files in your documents folder for instances containing the word 'basket' you
would do:

~$ search "basket" ~/documents/

Suppose you didn't want results containing "basketball", etc. You would do:

~$ search "basket\s" ~/documents/

In order to get a quick introduction to regular expressions, visit
<http://docs.python.org/dev/howto/regex.html>

Type 'search' with no command arguments to get a full list of options.

Installation
------------

search simply requires Python in order to run. It has only been tested on
python version 2.4.3, but should work for all subsequent 2.X versions.

Documentation
-------------

This IS the documentation.

Licensing
---------

See the file called LICENSE.

Bug Reports
-----------

Please send bug reports to <tlatorre9@gmail.com>

That's all folks!
-----------------

--Anthony LaTorre <tlatorre9@gmail.com>