== README
=API
=Accepted headers
- Accept: application/json
- Accept: application/xml
Base URL https://warm-castle-7655.herokuapp.com/
PATHS
HTTP method | url | result |
---|---|---|
GET | .../users/ | all users |
GET | .../decks/ | all decks |
GET | .../decks?owner_id=3 | all decks for user with id 3 |
GET | .../decks/4 | deck with id 4 |
This README would normally document whatever steps are necessary to get the application up and running.
Things you may want to cover:
-
Ruby version
-
System dependencies
-
Configuration
-
Database creation
-
Database initialization
-
How to run the test suite
-
Services (job queues, cache servers, search engines, etc.)
-
Deployment instructions
-
...
Please feel free to use a different markup language if you do not plan to run rake doc:app.