This README would normally document whatever steps are necessary to get the application up and running.
Things you may want to cover:
-
Ruby version ruby-2.5.3
-
System dependencies postgresql
-
Configuration
-
Database creation rails db:create
-
Database initialization rails db:migrate rails db:seed
-
How to run the test suite bundle exec rspec
-
Services (job queues, cache servers, search engines, etc.)
-
Deployment instructions
-
...