diff --git a/README.md b/README.md index 85268fc2ce154d20e634ab97b64315aa40bd8ac0..584541c3577ad56a106f0d521fad496e3b6799a8 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,17 @@ # XKCDAltTextBot -This bot will reply to tweets from [@xkcdComic](https://twitter.com/xkcdComic) with the alt text of XKCD posts. Currently in development. +This Twitter bot replies to tweets from [@xkcdComic](https://twitter.com/xkcdComic) with the alt text of the most recent XKCD comic. + +### Example + + + +## Implementation + +This bot will run on the [Heroku](https://www.heroku.com/) platform. More details are coming soon! + +## Contributing and Forks + +Feel free to fork this project and modify it for your own Twitter bot. (The license can be found [here](LICENSE).) + +If you want to contribute to the project, open a pull request with your branch. If your changes modify the core function of the bot, you will need to ensure that it continues to work as expected, and gracefully handles failures.