Readme and license

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Alex Musayev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,19 +1,36 @@
 # Freefeed Feeder
 
-Copy `.env.example` to `.env` with a real Freefeed auth token.
+Local set up:
 
-Background jobs:
+1. Copy `.env.example` to `.env`, with real env var values.
+
+Heroku deployment:
+
+1. Required resources: Heroku Postgres, Heroku Scheduler.
+2. Ensure env vars from `.env.example` are set.
+3. Migrate DB: `heroku run --app freefeed-feeder rails db:migrate`
+4. Schedule `rails pull:all` task.
+
+Running background jobs:
 
     rails jobs:work
 
-Refresh all feeds:
+Running web frontend:
+
+    rails server
+
+Schedule background jobs to refresh all feeds:
 
     rails pull:all
 
-Crontab:
+Refresh all feeds every hour:
 
     0 * * * * cd ~/freefeed-feeder && ~/.rbenv/shims/bundle exec rails pull:all > ~/freefeed-feeder/log/cron.log 2>&1
 
-DB migration during Heroku deployment:
+Run Rake task on Heroku instance:
+
+    heroku run --app freefeed-feeder rails pull:all
+
+Watch the log:
 
-    heroku run --app freefeed-feeder rails db:migrate
+    heroku logs --app freefeed-feeder --tail