Skip to content


Updated readme #1

merged 1 commit into from

2 participants


Changed the readme to markdown, added a description (based off of Viso's), and listed the prerequisites required to get it running on a fresh setup. Thoughts?

@lmarburger lmarburger merged commit 9b1c50c into cloudapp:master


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Showing with 38 additions and 3 deletions.
  1. +0 −3 README
  2. +38 −0
@@ -1,3 +0,0 @@
-Generate thumbnails for items stored on CloudApp.
-Pollex is released under the MIT license.
@@ -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.
+[cloudapp api]:
+## 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>
+## 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.
+## License
+Pollex is released under the MIT license.
Something went wrong with that request. Please try again.