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
https://www.theodinproject.com/lessons/ruby-on-rails-kittens-api
Building a kittens API
- building Rails application that serves as a RESTful API.
- Create a Kitten model with attributes name, age, cuteness and softness
- ...