From 16fd4078fe971f021064460a2f6762b764549d7e Mon Sep 17 00:00:00 2001
From: Kelly Rauchenberger <fefferburbia@gmail.com>
Date: Wed, 9 Mar 2016 10:35:03 -0500
Subject: Added readme

---
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..243ef97
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# nancy
+nancy is a simple twitter bot inspired by the following tweet:
+
+<blockquote class="twitter-tweet" data-lang="en"><p lang="en" dir="ltr">Nancy Drew and the Secret of the Ovipositor</p>&mdash; ruben ferdinand✨ (@urbanfriendden) <a href="https://twitter.com/urbanfriendden/status/707544674349797378">March 9, 2016</a></blockquote>
+<script async src="//platform.twitter.com/widgets.js" charset="utf-8"></script>
+
+It tweets a new Nancy Drew ebook title every three hours. Currently, it uses the [WordNet database](http://wordnet.princeton.edu/wordnet/) to pick adjectives and nouns describing the Nancy's latest misadventures.
+
+The 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.
+
+The canonical furries handle is [@nancy_ebooks](https://twitter.com/nancy_ebooks).
-- 
cgit 1.4.1