This README would normally document whatever steps are necessary to get the application up and running.
Things you may want to cover:
Ruby version 2.3
-
System dependencies
-
Configuration You'll need to set some environment vars: Facebook: ENV["FB_ACCESS_TOKEN"] ENV["FB_APP_ACCESS_TOKEN"] ENV["FB_APP_ID"] ENV["FB_APP_SECRET]
Twitter:
ENV["TW_CONSUMER_KEY"]
ENV["TW_CONSUMER_SECRET"]
ENV["TW_ACCESS_TOKEN"]
ENV["TW_ACCESS_TOKEN_SECRET"]
-
Database creation
-
Database initialization
-
How to run the test suite
-
Services (job queues, cache servers, search engines, etc.)
-
Deployment instructions
-
...