Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Copy edited and cleaned up a bit. #22

Merged
merged 1 commit into from
Sep 28, 2014
Merged

Copy edited and cleaned up a bit. #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 9 additions & 5 deletions README.md
View file
Open in desktop
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.