mdonoughe-wtth 1.0.0 → 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/README.markdown +5 -3
- data/bin/wtth +1 -1
- metadata +1 -1
data/README.markdown
CHANGED
@@ -7,10 +7,12 @@ Please only run one WTTH or similar per game. Check to see if your game already
|
|
7
7
|
## Installation
|
8
8
|
WTTH is written in [Ruby](http://www.ruby-lang.org/) and requires the [nokogiri](http://nokogiri.rubyforge.org/) and [twitter](http://twitter.rubyforge.org/) [gems](http://docs.rubygems.org/).
|
9
9
|
|
10
|
-
|
10
|
+
WTTH now has a gem in the [GitHub gem source](http://gems.github.com/) and can be installed as `mdonoughe-wtth`. This should install all the dependencies and put `wtth` into your path like magic.
|
11
11
|
|
12
|
-
|
12
|
+
After you've gotten everything installed, run `wtth init` to give the program access to a Twitter account. I'd suggest not using your usual Twitter account for this.
|
13
13
|
|
14
|
-
|
14
|
+
Running `wtth init` will create a file called `.wtth.yml` in your home directory. You'll want to open that and change `player_list_uri` to point at the correct HVZ Source page for your game.
|
15
|
+
|
16
|
+
You'll probably want to make some sort of cron job to run `wtth`. It makes at most one request to HVZ Source and posts at most one message to Twitter per run. Set this to a responsible interval. You can probably get away with as low as once a minute, but that's completely unnecessary in my opinion.
|
15
17
|
|
16
18
|
Please remember not to have the cron job running when the game is not in session.
|
data/bin/wtth
CHANGED