readme and changelog

CHANGELOG.md

@@ -0,0 +1,50 @@
+1.2.0 / 2016-05-31
+==================
+
+  * 1.2.0
+  * preparation for next version
+  * fixes youtube sources
+  * updates almost every dependency
+  * adds npm script 'stop' that clear statistics.json and storage.json
+  * fix statistics
+  * add file stubs and cleanup
+  * updates osmosis lib
+  * introduces statistics
+  * fix link
+  * remove evil source ;-)
+  * Init basic config and setup
+  * cleanup
+  * new sources and bugfixes
+  * bump version 1.1.0
+  * next major alpha
+  * keep jslint happy
+
+1.1.0 / 2015-08-19
+==================
+
+  * Update README.md
+    fix syntax
+  * update dependencies
+  * remove bidl scraper
+  * add support for settings
+  * fix transfermarkt mw
+  * twitter now ignore comments of followed accounts
+  * introduce settings
+  * remove xray dependency
+  * add bild scraper
+  * update osmosis lib
+  * add htaccess
+  * update git ignore
+  * enable storage clean logic again
+  * addd  sge hash to tweet plugin
+  * adjust console reporter plugin
+  * update readme
+  * add bild scraper; remove outdated faz twitter plugin
+  * add twitter fussballverletzungen; twitter alex meiner;
+  * update libs and prepare replacement of osmosis with x-ray
+  * add ligainsider source
+  * fixes fr feed
+  * unlicense; add tmmw source;
+  * remove directory 'plugins.deactivated'
+  * v.1.0.2
+    fixed bug: wrong content selector

README.md

@@ -2,24 +2,34 @@
 
 > eintracht frankfurt news bot
 
-- collect news of different source types (feeds, twitter, websites)
+- collects news of different source types (feeds, twitter, websites)
 - twitters title, link and source-hashtag
 
 ## badges
 
-[![npm](https://img.shields.io/npm/dm/node-sge-bot.svg)](https://www.npmjs.com/package/node-sge-bot)
-[![David](https://img.shields.io/david/solygen/node-sge-bot.svg?style=flat-square)](https://david-dm.org/solygen/node-sge-bot)
-
-[![David](https://img.shields.io/david/dev/solygen/node-sge-bot.svg?style=flat-square)](https://david-dm.org/solygen/node-sge-bot#info=devDependencies&view=table)
+- [![npm](https://img.shields.io/npm/dm/node-sge-bot.svg)](https://www.npmjs.com/package/node-sge-bot)
+- [![David](https://img.shields.io/david/solygen/node-sge-bot.svg?style=flat-square)](https://david-dm.org/solygen/node-sge-bot)
+- [![David](https://img.shields.io/david/dev/solygen/node-sge-bot.svg?style=flat-square)](https://david-dm.org/solygen/node-sge-bot#info=devDependencies&view=table)
 
 ## demo / twitter account
 
 [twitter.com/sge_bot](https://twitter.com/sge_bot)
 
+
+## getting started
+
+- download/clone the repo
+- add you credentials (`data/bitly.json`, `data/twitter.json`)
+- enable twitter output by adding 'twitter' to reporters at `data/settings`
+- run `npm start`
+- enable debug output with `DEBUG=app,scrape,reporting,twitter,flow node bin/bot.js`
+
+
 ## twitter avatar
 
 Metal House – Terebi Robot
 
 ![image](http://upload.wikimedia.org/wikipedia/commons/thumb/b/b5/Metal_House_%E2%80%93_Terebi_Robot_%28%E3%83%86%E3%83%AC%E3%83%93_%E3%83%AD%E3%83%9C%E3%83%83%E3%83%88-_Television_Robot%29_%E2%80%93_Close_Up.jpg/90px-Metal_House_%E2%80%93_Terebi_Robot_%28%E3%83%86%E3%83%AC%E3%83%93_%E3%83%AD%E3%83%9C%E3%83%83%E3%83%88-_Television_Robot%29_%E2%80%93_Close_Up.jpg)
 
 [http://commons.wikimedia.org/wiki/File:Metal_House_[...]Close_Up.jpg](http://commons.wikimedia.org/wiki/File:Metal_House_%E2%80%93_Terebi_Robot_(%E3%83%86%E3%83%AC%E3%83%93_%E3%83%AD%E3%83%9C%E3%83%83%E3%83%88-_Television_Robot)_%E2%80%93_Close_Up.jpg)
+

package.json

@@ -5,7 +5,6 @@
   "main": "bin/bot.js",
   "scripts": {
     "start": "node bin/bot.js",
-    "debug": "DEBUG=app,scrape,reporting,twitter,flow node bin/bot.js",
     "stop": "echo '{}' > data/storage.json && echo '{}' > data/statistics.json",
     "test": "echo \"Error: no test specified\" && exit 1",
     "publish-please": "publish-please",