documentation

README.md

@@ -1,26 +1,47 @@
 # Aqui
 
-TODO: Write a gem description
+[![Build Status](https://travis-ci.org/hstove/aqui.svg?branch=master)](https://travis-ci.org/hstove/aqui)
+[![Code Climate](https://codeclimate.com/github/hstove/aqui.png)](https://codeclimate.com/github/hstove/aqui)
 
-## Installation
+A gem for making sure some code is running.
 
-Add this line to your application's Gemfile:
+Sometimes when coding, you run into a situation where you want to make sure
+a bit of code is being executed by your application. You might end up
+typing something like:
 
-```ruby
-gem 'aqui'
-```
+~~~ruby
+try_this
+puts 'this is running'
+try_another
+puts 'blasfdd'
+~~~
+
+This way, you can run your code and check your logs to see if the `put`
+methods were called. If this short and simple effective method works for you,
+then give `aqui` a shot next time. It looks like this:
+
+~~~ruby
+try_this
+aqui
+try_another
+aqui
+~~~
 
-And then execute:
+This time, the output is colorized and contains information about where the code is running:
 
-    $ bundle
+![screenshot](http://i.imgur.com/2AdA8YB.png)
 
-Or install it yourself as:
+## Installation
 
-    $ gem install aqui
+```ruby
+gem 'aqui'
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+aqui
+```
 
 ## Contributing
 

script/demo.rb

@@ -0,0 +1,13 @@
+require "bundler/setup"
+Bundler.require
+
+class ClassName
+  def go
+    1 + 2
+    aqui
+    3 + 4
+    aqui
+  end
+end
+
+Model.new.go