1 files changed, 38 insertions, 0 deletions

diff --git a/README b/README
new file mode 100755
index 0000000..8dbe856
--- /dev/null
+++ b/README
@@ -0,0 +1,38 @@
+# VoiceOfHangzhou
+
+A bot that catches Ingress comm messages and forwardes them to Telegram channel.
+
+## Dependencies
+
++ *nix like OS, tested on Ubuntu
+
++ Python3
+
++ [Python-Telegram-Bot](https://github.com/python-telegram-bot/python-telegram-bot)
+
++ selenium
+
+```bash
+sudo pip3 install selenium
+```
+
++ [Phantomjs](http://phantomjs.org/)
+
+## Usage
+
++ Make sure your OS support coresponding locales based on your comm range.
+
+e.g. zh_CN.UTF-8
+
+```bash
+sudo locale-gen zh_CN.UTF-8
+sudo dpkg-reconfigure locales
+```
+
++ Copy `config.json.example` to `config.json` first, and remember to modify `config.json` and `PhantomjsPath` in `bot.py`
+
+To run, just type
+
+```bash
+python3 bot.py
+```
\ No newline at end of file