diff options
| -rw-r--r-- | README.md | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..7080287 --- /dev/null +++ b/README.md @@ -0,0 +1,56 @@ +Meetup Find Events RSS +====================== + +Generates an RSS feed of upcoming events on [Meetup][1]. This makes it easier to +be informed of meetups even in groups you don’t participate in. + +The program is designed to run locally at a recurring interval (via `cron` or +`launchd` for example), generating an XML feed file. + + +## Usage +The following shell script generates a new feed and writes it to the +`meetup-upcoming.xml` file: + + #!/bin/sh + + meetup-find-events-rss \ + --meetup-api-token YOUR_TOKEN \ + --latitude 48.8692 \ + --longitude 2.34777 \ + --end-date 2018-04-15 \ + > ~/meetup-upcoming.xml + +A Meetup API token can be obtained from [TODO][2]. + + +## Example +Here's a demonstration of the result of the above script in Newsboat. + + echo '~/meetup-upcoming.xml' >> ~/.newsboat/urls + +[TODO demo gif] + + +## Install +A binary built for Mac OS X is available on the [releases][3] page. Download the +binary and put it in your `PATH`. + +To compile from source: + + $ cargo install --git https://github.com/teddywing/meetup-find-events-rss.git --root /usr/local + + +## Uninstall + + $ cargo uninstall --root /usr/local meetup-find-events-rss + + +## License +Copyright © 2018 Teddy Wing. Licensed under the GNU GPLv3+ (see the included +COPYING file). + + +[1]: https://www.meetup.com/ +[2]: TODO +[3]: https://github.com/teddywing/meetup-find-events-rss/releases |