From cff3f50819073668391465dd8121bf9e0b8a7c33 Mon Sep 17 00:00:00 2001
From: Jinwei Zhao <i@jinwei.me>
Date: Mon, 2 Jan 2017 22:05:33 +0800
Subject: init

---
 README | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100755 README

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
-- 
cgit v1.2.3