diff --git a/README.md b/README.md index 57f36a8..e28f0ad 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,11 @@ # Foursquare Feeds -A python script that will generate an iCal (`.ics`) feed of your checkins on [Foursquare][4sq]/[Swarm][swarm]. If you set it up to save this file to a publicly-visible location on a webserver, and run the script regularly, you can subscribe to the feed in your favourite calendar application. +A python script that will generate iCal (`.ics`) or KML files of your checkins on [Foursquare][4sq]/[Swarm][swarm]. + +If you set it up to save the iCal file to a publicly-visible location on a webserver, and run the script regularly, you can subscribe to the feed in your favourite calendar application. + +A KML file can be loaded into a mapping application (such as Google Earth or +Maps) to view the checkins on a map. Foursquare [used to have such feeds][feeds] but they've stopped working for me. [I wrote a bit about this.][blog] @@ -93,7 +98,7 @@ Enter this in your `config.ini`. ## Run the script -You're ready to go: +Generate a `.ics` file: $ ./generate_feeds.py @@ -104,6 +109,9 @@ If the file is generated in a location on your website that's publicly-visible, Note that the file might contain private checkins or information you don't want to be public. In which case, it's probably best to make the name of any such publicly-readable file very obscure. +To generate a `.kml` file, see the `kind` option below. + + ### Script options #### `--all` @@ -118,6 +126,18 @@ Depending on how many checkins you have you might only want to run it with `--all` the first time and, once that's imported into a calendar application, subsequently only fetch recent checkins. +### `-k` or `--kind` + +By default the script generates an iCal `.ics` file. Or, use this option to +specify an `.ics` file or a `.kml` file: + +```bash +$ ./generate_feeds.py -k ics +$ ./generate_feeds.py -k kml +$ ./generate_feeds.py --kind=ics +$ ./generate_feeds.py --kind=kml +``` + #### `-v` or `--verbose` By default the script will only output text if something goes wrong. To get