Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

update README.md with development only notes #7

Merged
merged 1 commit into from almost 2 years ago

2 participants

Richard B Richard Schneeman
Richard B
rbishop commented

Add more notes indicating that this gem will work in development only. Also added a snippet how to add it to a development group in the Gemfile.

PS: My boss loves the gem but forbid using it because he didn't see the notes about development only. ;)

Richard Schneeman
Owner

:thumbsup:

Richard Schneeman schneems merged commit 8bf6371 into from
Richard Schneeman schneems closed this
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Showing 1 unique commit by 1 author.

May 24, 2012
update README.md with development notes 08d6224
This page is out of date. Refresh to see the latest.

Showing 1 changed file with 5 additions and 4 deletions. Show diff stats Hide diff stats

  1. 9  README.md
9  README.md
Source Rendered
@@ -4,22 +4,24 @@ Helps you find your routes on a long Journey on Rails
4 4
 
5 5
 ## What
6 6
 
7  
-Show routes in your Rails app. Visit `http://localhost:3000/rails/routes` and you'll see an output similar to `rake routes`
  7
+Show routes in your Rails app while working in development. Visit `http://localhost:3000/rails/routes` and you'll see an output similar to `rake routes`
8 8
 
9 9
 ![Sextant Gem](http://media.tumblr.com/tumblr_m42lwz86aB1qevexf.png)
10 10
 
11 11
 
12 12
 ## Why?
13 13
 
14  
-Running `rake routes` is slow and painful, mostly due to the time to initialize rails. Since you likely have your rails server booted, you can save this time by rendering the routes in a web request. You can only develop as quick as your tools will allow, so speeding up your tools speeds your development. Sextant allows you to quickly see your routes.
  14
+Running `rake routes` is slow and painful, mostly due to the time to initialize rails. When you're working in development you likely have your rails server booted, you can save this time by rendering the routes in a web request. You can only develop as quick as your tools will allow, so speeding up your tools speeds your development. Sextant allows you to quickly see your routes.
15 15
 
16 16
 
17 17
 ## Install
18 18
 
19  
-Add this to your Gemfile
  19
+Add this to the development group in your Gemfile
20 20
 
21 21
 ```ruby
  22
+group :development do
22 23
   gem 'sextant'
  24
+end
23 25
 ```
24 26
 
25 27
 Then run `bundle install` and you're ready to start
@@ -29,7 +31,6 @@ Then run `bundle install` and you're ready to start
29 31
 
30 32
 Visit `/rails/routes` in your app and you'll see your routes. It's that simple.
31 33
 
32  
-Don't worry you can only see this info in development
33 34
 
34 35
 ## About
35 36
 
Commit_comment_tip

Tip: You can add notes to lines in a file. Hover to the left of a line to make a note

Something went wrong with that request. Please try again.