diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..1c69a9f --- /dev/null +++ b/README.rst @@ -0,0 +1,62 @@ +Haystack: Holding All the Needles +================================== + + +**Haystack** is a module that solves your problems. + +Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod +tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, +quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo +consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse +cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non +proident, sunt in culpa qui officia deserunt mollit anim id est laborum. + + +Usage +----- + +Haystack is simple. Beautiful. :: + + import haystack + ... + + +Installation +------------ + +Installing haystack is easy:: + + $ pip install haystack + +Or, if you must:: + + $ easy_install haystack + +But, `you really shouldn't do that +`_. + + +License +------- + +Haystack is released under the Apache License, v2:: + + Copyright 2011 Kenneth Reitz + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + +Contribution +------------ + +If you'd like to contribute, simply fork the repository, commit your changes to the develop branch (or branch off of it), and send a pull request. Make sure you add yourself to AUTHORS. \ No newline at end of file