Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Updated readme with a bit more info, and prerequisites

  • Loading branch information...
commit e1bc69a0a2934e2413ddf22bb8a86da7e2e142eb 1 parent 2f7ccb1
@danthompson authored
Showing with 38 additions and 3 deletions.
  1. +0 −3  README
  2. +38 −0 README.md
View
3  README
@@ -1,3 +0,0 @@
-Generate thumbnails for items stored on CloudApp.
-
-Pollex is released under the MIT license.
View
38 README.md
@@ -0,0 +1,38 @@
+# Pollex
+
+Pollex generates thumbnails for items stored on CloudApp. It's a thin client
+that at its heart is a simple [Sinatra] app which pings
+the [CloudApp API] for its details, and renders a thumbnail or icon according
+to the type of drop.
+
+[sinatra]: https://github.com/sinatra/sinatra
+[cloudapp api]: http://developer.getcloudapp.com/view-item
+
+## Prerequisites
+
+Pollex's needs are basic:
+
+* Ruby 1.9.3 - If using RVM, then... <code>rvm install 1.9.3</code>
+* [Bundler]
+* An Event Machine based web server such as [Thin]
+* [ImageMagick] - If using Homebrew... <code>brew install imagemagick</code>
+
+
+[thin]: http://code.macournoyer.com/thin/
+[bundler]: https://github.com/carlhuda/bundler
+[imagemagick]: http://www.imagemagick.org/
+
+## Parting Words
+
+We'd love to see what you're doing with Pollex. [Get a hold of us][twitter] and
+show it off! Did you find something broken? Have questions getting things
+running? [Open an issue][issue] or send over a pull request.
+
+
+[twitter]: http://twitter.com/cloudapp
+[issue]: https://github.com/cloudapp/pollex/issues
+
+
+## License
+
+Pollex is released under the MIT license.
Please sign in to comment.
Something went wrong with that request. Please try again.