Skip to content

Commit

Permalink
Merge pull request #22 from AstroCB/patch-1
Browse files Browse the repository at this point in the history
Copy edited and cleaned up a bit.
  • Loading branch information
Undo1 committed Sep 28, 2014
2 parents 31528b4 + 5a8b57c commit 1304d63
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
SmokeDetector
=============

Headless chatbot that detects spam and posts it to chatrooms. Uses [ChatExchange](https://github.com/Manishearth/ChatExchange) and takes questions from the [realtime tab](http://stackexchange.com/questions?tab=realtime)
Headless chatbot that detects spam and posts it to chatrooms. Uses [ChatExchange](https://github.com/Manishearth/ChatExchange) and takes questions from the Stack Exchange [realtime tab](http://stackexchange.com/questions?tab=realtime).

[Example chatpost](http://chat.meta.stackoverflow.com/transcript/message/1784471#1784471)
Example [chat post](http://chat.meta.stackoverflow.com/transcript/message/1784471#1784471):

To setup:
![Example chat post](http://i.stack.imgur.com/bYuDX.png)

To set up, use

```
git clone https://github.com/Charcoal-SE/SmokeDetector.git
Expand All @@ -18,7 +20,9 @@ sudo pip install websocket-client --upgrade
sudo pip install phonenumbers
```

To run: `python ws.py`, preferably in a daemon-able mode. Like in a `screen` session.
To run, use `python ws.py` (preferably in a daemon-able mode). Like in a `screen` session.


You can run `. ChatExchange/setp.sh` to set local environment variables so that you don't have to log in every time.

You can run `. ChatExchange/setp.sh` to set local environment variables so that you don't have to log in every time. Only supports SE openids for now
Only supports Stack Exchange OpenIDs for now.

0 comments on commit 1304d63

Please sign in to comment.