README.md in galago-router-0.1.1 vs README.md in galago-router-0.2.0
- old
+ new
@@ -1,8 +1,8 @@
# Galago Router
-A rack router.
+Simple, efficient routing for rack applications.
## Installation
Add this line to your application's Gemfile:
@@ -37,9 +37,43 @@
end
end
run router
```
+
+## Routes
+
+### OPTIONS
+
+OPTIONS endpoints are automatically defined for each resource provided. The
+response will contain an ALLOW header listing the request methods the resource
+supports.
+
+### HEAD
+
+HEAD endpoints are automatically defined for each resource that supports GET.
+
+
+## Environment
+
+The router adds information about the route that was called to the environment.
+All requests will have the following keys added:
+
+| Key | Example Value |
+| :------------------- | :------------ |
+| galago_router.path | '/users/:id' |
+| galago_router.params | { id: 42 } |
+
+
+## Responses
+
+### 405 Method Not Allowed
+
+In the event a path is requested with an unsupported method, the router will return a method not allowed response.
+This consists of a 405 status code and an 'Allow' header listing the valid request methods.
+
+More information: http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
+
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)