Permalink
Browse files

Updated README to showcase the new `desc` method

  • Loading branch information...
1 parent a2abc5b commit 83b14808a56bbaeffeae78c158076ccd24ce37ae @fredwu committed Aug 2, 2012
Showing with 10 additions and 0 deletions.
  1. +10 −0 README.md
View
@@ -34,6 +34,7 @@ In `routes.rb`, define parameters for each API endpoint after the normal routes
```ruby
if Rails.env.development?
ApiTaster.routes do
+ desc 'Get a __list__ of users'
get '/users'
post '/users', {
@@ -78,6 +79,15 @@ ApiTaster.routes do
end
```
+### Commenting API Endpoints
+
+Before each route definitions, you may use `desc` to add some comments. Markdown is supported.
+
+```ruby
+desc 'Get a __list__ of users'
+get '/users'
+```
+
### Missing Route Definitions Detection
Instead of manually finding out which route definitions you need, API Taster provides a warning page that shows you all the missing definitions.

0 comments on commit 83b1480

Please sign in to comment.