A new face for hackbot.

Author: kern

.gitignore

@@ -35,3 +35,4 @@ doc
 # Hackbot
 hackbot.db
 record
+dist

.npmignore

@@ -0,0 +1,49 @@
+# Logs
+log
+logs
+*.log
+npm-debug.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directory
+# https://docs.npmjs.com/misc/faq#should-i-check-my-node-modules-folder-into-git
+node_modules
+
+# OSX
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+.AppleDouble
+.LSOverride
+Icon
+
+# Java
+*.class
+
+# Sources
+src
+resources/logo.png
+resources/logo.sketch

README.md

@@ -1,12 +1,8 @@
-# hackbot
+<img src="https://raw.githubusercontent.com/kern/hackbot/master/resources/logo.png" alt="hackbot" width="254" />
 
-A customizable Facebook Group embetterment robot.
+Hackbot adds features to Facebook Groups through automation.
 
-Hackbot uses the Facebook Graph API to implement extra moderative features that are not currently available to group administrators. At the moment, it only supports the closing of comment threads, but it's designed to be highly extensible.
-
-An instance of hackbot is running on [Hackathon Hackers][hh].
-
-[hh]: http://hh.gd
+An instance of hackbot is running on [Hackathon Hackers](https://facebook.com/groups/hackathonhackers).
 
 ## Installation
 
@@ -46,73 +42,34 @@ web-based flow][oauth-issue].
 [explorer]: https://developers.facebook.com/tools/explorer/
 [oauth-issue]: https://github.com/kern/hackbot/issues/6
 
-### 2. Install dependencies
-
-    $ npm install
-
-### 3. Set up Firebase
-
-Persistence is currently done via [Firebase](www.firebase.com).
-
-Set up a Firebase datastore and export the URL and secret as environment variables:
-
-    $ export FIREBASE_SECRET='<yo-secret>'
-    $ export FIREBASE_URL='<firebase-url>
-
-In your Firebase you need to add the following keys:
+### 2. Collect the Graph IDs of your group's moderators
 
-```json
-{
-    "accessToken": "<your-fb-access-token>",
-    "id": "<your-fb-group-id>",
-    "mods": ["<mod-id-1>", "<mod-id-2>"]
-}
-```
+You can use the [Graph API Explorer][explorer] to find the numeric Graph API
+IDs of your group's moderators.
 
-### 4. Set up Hackbot basic
+[explorer]: https://developers.facebook.com/tools/explorer/
 
-Hackbot has optional but on-by-default Twitter and MetaMind integrations. If
-you only wish to run the Facebook integrations you can set the following
-environment variable:
+### 3. Install Hackbot
 
-    $ export BASIC=1
+    $ npm install -g hackbot
 
 ## Usage
 
-To start the hackbot, use your long-lived access token and run:
-
-    $ env ACCESS_TOKEN=[LONG_LIVED_ACCESS_TOKEN] npm start
-
-Currently, there is no way to update the access token without restarting the
-hackbot. You can set the port for the HTTP server using the `PORT` environment
-variable.
-
-To generate the docs:
+There will be much better usage docs coming soon, but here's how it works:
 
-    $ npm run doc
-    $ open doc/index.html
+    $ hackbot GROUP_ID ACCESS_TOKEN -m MOD_ID1,MOD_ID2,MOD_ID3 -s close,delete --interval 5
 
-Logs are stored in `log/` and are rotated daily. To view the logs:
+## Development
 
-    $ npm run log
+Hackbot uses [JavaScript Standard Style](https://github.com/feross/standard) and [Babel](https://babeljs.io/) for ES6+ support.
 
-## Adding Filters
-
-Filters are the fundamental units of extension for hackbot.
-
-You can add thread filters under the `lib/filters` directory. An [example
-closed thread filter][close-file] is provided.
-
-Filters are functions that receive an array of posts, representing a
-post/comment thread on the Facebook Group. Items of the array are [Post
-objects][post-file] where the first item is the original post.
+    $ git clone [email protected]:pavlovml/gallup.git
+    $ npm install
+    $ npm run dev -- [see usage above]
 
-If you add a filter, make sure to add its exported function to the `filters`
-array in the [index file][index-file].
+Lint before committing:
 
-[close-file]: https://github.com/kern/hackbot/blob/master/lib/filters/close.js
-[post-file]: https://github.com/kern/hackbot/blob/master/lib/Post.js
-[index-file]: https://github.com/kern/hackbot/blob/master/lib/index.js
+    $ npm run lint
 
 ## License & Acknowledgements