瀏覽代碼

Merge branch 'master' of github.com:fphammerle/tooncher

Fabian Peter Hammerle 6 年之前
父節點
當前提交
c8f0c4b9b4
共有 1 個文件被更改,包括 31 次插入0 次删除
  1. 31 0
      README.md

+ 31 - 0
README.md

@@ -1,2 +1,33 @@
 # tooncher
 automates toontown rewritten's login process
+
+## Installation
+
+    $ pip3 install --user --upgrade tooncher
+
+## Configuration
+
+```yaml
+# default path: $HOME/.tooncher
+accounts:
+- username: toon
+  password: secret
+- username: ceo
+  password: golf
+- username: cfo
+  password: train
+engine_path: '/opt/Toontown Rewritten/TTREngine'
+```
+
+## Usage
+
+```
+$ tooncher [username]
+```
+
+### Examples
+
+```
+$ tooncher toon
+$ tooncher ceo
+```