aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1a1179c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+Clips
+=====
+
+An Instapaper-ish web application that allows you to collect URLs to check later. Collect URLs using the included bookmarlet, which saves the URL of the current page.
+
+
+# Running the application
+Clips is written in [Campfire](http://campfire.io). Start by `bundle install`ing gems. Then start the server.
+
+ $ bundle install
+ $ rackup
+
+Use [Rerun](https://github.com/rerun/rerun) to auto-restart the server when the filesystem changes:
+
+ $ rerun -- rackup