README.md in arkenstone-0.1.0 vs README.md in arkenstone-0.2.0

- old
+ new

@@ -1,39 +1,49 @@ -# Arkenstone +# The Arkenstone -[![Build Status](https://travis-ci.org/ngscheurich/arkenstone.svg?branch=master)](https://travis-ci.org/ngscheurich/arkenstone) -[![Code Climate](https://codeclimate.com/github/ngscheurich/arkenstone/badges/gpa.svg)](https://codeclimate.com/github/ngscheurich/arkenstone) +[![Build Status](https://circleci.com/gh/ngscheurich/arkenstone.svg?&style=shield)](https://circleci.com/gh/ngscheurich/arkenstone) +[![Code Coverage](https://codecov.io/github/ngscheurich/arkenstone/coverage.svg?branch=master)](https://codecov.io/github/ngscheurich/arkenstone?branch=master) -The Arkenstone is a Ruby on Rails application generator set up to use my -preferred development configuration. It is heavily influenced by thoughtbot’s -Suspenders; I simply prefer to have something that I’ve pruned from infancy -and just totally *get*, you know? +The Arkenstone is a Ruby on Rails development environment generator. Its +goal is to provide an easy way to spin up a new Vagrant box provisioned +for Rails development. ## Installation -Add this line to your application’s Gemfile: + $ gem install arkenstone -```ruby -gem "arkenstone" -``` +## Usage -And then execute: +The Arkenstone provides you with the command line application `arkenstone`. +To create a new Arkenstone environment: - $ bundle + $ arkenstone new path/to/app -Or install it yourself with: +Check out the `arkenstone help new` option to see the available +configuration options. - $ gem install arkenstone +Once, you’ve generated your new environment, `cd` over to `path/to/app` +and run: -## Usage + $ vagrant up -The Arkenstone provides you with the command line application `arkenstone`, -which behaves essentially like `rails new`. To create a Rails app with -The Arkenstone, simply: +Now go grab a cup of coffee or a glass of Scotch—this part might take a +while. The Arkenstone is busy building a new Vagrant box and doing some +initial work for you like: - $ arkenstone path/to/app +- Installing system software depencies +- Building and installing Ruby +- Installing and setting up PostgreSQL +- Generating a new Rails app with [Suspenders](https://github.com/thoughtbot/suspenders) -Check out the `--help` option to see the available configuration options. +When your new environment is complete, SSH into it and fire up +the Rails server: + + $ vagrant ssh + $ cd /vagrant && bin/rails server -b 0.0.0.0 + +You should now be able to visit your Rails app on your host machine at +[http://localhost:3001](http://localhost:3001). Voilà! --- [(ↄ) Copyleft](http://www.gnu.org/licenses/copyleft.en.html) Nicholas Gunther Scheurich under the