aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorTeddy Wing2013-04-07 01:05:43 -0400
committerTeddy Wing2013-04-07 01:05:43 -0400
commitc4ee5d6b51116a4405e7e02b5220ce98d9cccd92 (patch)
treea4fab3abde285bf86d296fd73a61add1f33ba6a2 /README.md
parentbfa6c83b8c9cfca37eb5c1ac07f2098b898c771b (diff)
downloadclips-c4ee5d6b51116a4405e7e02b5220ce98d9cccd92.tar.bz2
Add README
Diffstat (limited to 'README.md')
-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