From 13fa804d967a771864466128eded8d46c1f13061 Mon Sep 17 00:00:00 2001 From: Cameron Rodriguez <rod.cam2014+dev@gmail.com> Date: Fri, 21 Dec 2018 19:38:19 -0500 Subject: [PATCH] updated README --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 85268fc..584541c 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. -- GitLab