README.md in simple-address-generator-0.0.7 vs README.md in simple-address-generator-0.0.8
- old
+ new
@@ -1,9 +1,13 @@
-# Simple::Address::Generator
+# simple-address-generator
-TODO: Write a gem description
+simple-address-generator is a Rails 3 generator that creates a small scaffold class called address that contains all the inputs needed for global address storage system. It is also ready with geocoding and Google maps integration.
+# Demo
+
+[simple-address-generator DEMO]: http://young-fire-9461.heroku.com/addresses
+
## Installation
Add this line to your application's Gemfile:
gem 'simple-address-generator'
@@ -16,10 +20,16 @@
$ gem install simple-address-generator
## Usage
-TODO: Write usage instructions here
+After adding to your Gemfile, you should run:
+
+ run g simple_address_generator
+
+Then you can access the following URL:
+
+ http://localhost:3000/addresses
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)