Permalink
Browse files

Update README with dev information.

  • Loading branch information...
1 parent ba0fb64 commit 312a3252097261f1d9a2d9ef8016d59d127b9850 @drapergeek committed Dec 17, 2012
Showing with 25 additions and 5 deletions.
  1. +25 −5 README.md
View
@@ -1,9 +1,29 @@
# shortstuff [![Build Status](https://secure.travis-ci.org/drapergeek/shortstuff.png?branch=master)](http://travis-ci.org/drapergeek/shortstuff) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/drapergeek/shortstuff)
============================
+shortstuff is a small rails app that acts as a URL shortener. It is designed for use inside a closed network where an admin can control the DNS server so you can make your own url service. It does not offer any authentication (this is by design) and URLs are never expired. There is a very simple JSON api for creating new URLs. I may release a CLI gem that interfaces with this via some kind of ENV configuration.
-Use the following guides for getting things done, programming well, and
-programming in style.
-* [Protocol](http://github.com/thoughtbot/guides/blob/master/protocol)
-* [Best Practices](http://github.com/thoughtbot/guides/blob/master/best-practices)
-* [Style](http://github.com/thoughtbot/guides/blob/master/style)
+## Development Setup
+
+Get the code.
+
+ git clone git@github.com:drapergeek/shortstuff.git
+
+Set up the project's dependencies.
+
+ cd project
+ bundle --binstubs
+
+This will automatically add a heroku remote for staging.
+
+Running tests:
+
+ rspec spec
+
+
+Use [Foreman](http://goo.gl/oy4uw) to run the app locally.
+
+ foreman start
+
+It uses your `.env` file and `Procfile` to run processes just like Heroku's
+[Cedar](https://devcenter.heroku.com/articles/cedar/) stack.

0 comments on commit 312a325

Please sign in to comment.