Permalink
Browse files

Updated readme with instructions.

  • Loading branch information...
1 parent 14016b5 commit 36541547faf958c3df83452534c2149f34e0a5e4 @jonmagic committed Oct 10, 2011
Showing with 28 additions and 1 deletion.
  1. +28 −1 README.md
View
@@ -1,3 +1,30 @@
# PDF Archive
-PDF Archive is a simple PDF storage and retrieval system. Uploading a PDF will store it, create a preview image for search listings, and extract the text from it so it can be indexed for search.
+PDF Archive is a simple PDF storage and retrieval system. Uploading a PDF will store it, create a preview image for search listings, and extract the text from it so it can be indexed for search.
+
+## Setup
+
+ git clone git://github.com/jonmagic/pdf_archive.git
+ cd pdf_archive
+ bundle
+
+## Run the tests
+
+ bundle exec rake
+
+## Run the app and background worker
+
+ gem install foreman
+ foreman start
+
+You can now open the app in your browser http://localhost:3000
+
+## License
+
+Copyright (c) 2011 Jonathan Hoyt
+
+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.

0 comments on commit 3654154

Please sign in to comment.