about summary refs log tree commit diff stats
path: root/README.md
diff options
context:
space:
mode:
authorKelly Rauchenberger <fefferburbia@gmail.com>2016-01-19 10:00:31 -0500
committerKelly Rauchenberger <fefferburbia@gmail.com>2016-01-19 10:00:31 -0500
commitb2a56c980ec6f9f32b94c9bd9294da2a1e9aef7c (patch)
treee8247648f8f541482fbd867fd38a317b3c415e50 /README.md
parentb9de9aed566b6ea24a449026ab72eccdeb7fddc5 (diff)
downloadfurries-b2a56c980ec6f9f32b94c9bd9294da2a1e9aef7c.tar.gz
furries-b2a56c980ec6f9f32b94c9bd9294da2a1e9aef7c.tar.bz2
furries-b2a56c980ec6f9f32b94c9bd9294da2a1e9aef7c.zip
the furries are self-documenting
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..30d30e7 --- /dev/null +++ b/README.md
@@ -0,0 +1,10 @@
1# furries
2furries is a simple twitter bot inspired by the following image:
3
4![the furries are back](http://www.wtae.com/image/view/-/20831998/highRes/1/-/maxh/630/maxw/1200/-/tyl7ng/-/img-The-Furries-Are-Back-Who-Are-They.jpg)
5
6It tweets something that the furries are every three hours. Currently, it uses the [WordNet database](http://wordnet.princeton.edu/wordnet/) to pick adjectives and adverbs describing the furries.
7
8The bot uses [YAMLcpp](https://github.com/jbeder/yaml-cpp) to read a configuration file, MySQL C API to read the WordNet database (seeded with [this MySQL version of WordNet 2.0](androidtech.com/html/wordnet-mysql-20.php)), and [twitcurl](https://github.com/swatkat/twitcurl) to send the status updates to Twitter.
9
10The canonical furries handle is [@thefurriesare](https://twitter.com/thefurriesare).