This app shows code related to the Medium article "Blazing Blade: Building a Simple API with Rails" and can be used as a reference for the many sections it is broken up into.
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
-
...