README.md in stackbuilders-campfire_export-0.4.0 vs README.md in stackbuilders-campfire_export-0.4.1

- old
+ new

@@ -5,10 +5,31 @@ ## Quick Start ## $ sudo gem install stackbuilders-campfire_export $ campfire_export +## Note ## + +This gem is a fork from the original version of this project by +[Marc Hedlund](https://github.com/precipice). While almost all of the work is +still his, this fork contains fixes and updates for user-facing issues, +including the following: + +* Upgrade gem dependencies and add support for Ruby versions >= 1.9.3 +* Retry up to 5 times before giving up on a resource. Makes campfire_export usable for large exports. +* Fixes file size validation when file contains Unicode. +* Allow export of a specific room instead of exporting all rooms on a Campfire account. + +When you install the gem following the instructions above (i.e., with the name +stackbuilders-campfire-export) you will get these fixes, and the project will run +on modern Ruby versions. + +We will try to respond to issues and pull requests on the +[Stack Builders](http://www.stackbuilders.com) fork of this repository +(https://github.com/stackbuilders/campfire_export), and to push new releases in +a timely manner to https://rubygems.org/gems/stackbuilders-campfire_export. + ## Intro ## I had an old, defunct [Campfire](http://campfirenow.com/) account with five years' worth of transcripts in it, some of them hilarious, others just memorable. Unfortunately, Campfire doesn't currently have an export function; @@ -58,9 +79,14 @@ #start_date: 2010/1/1 # OPTIONAL: Export end date - the last transcript you want exported. # Uncomment to set. Defaults to the date of the last comment in each room. #end_date: 2010/12/31 + + # OPTIONAL: Campfire room - the room you want exported. All other rooms + # will be skipped. + # Uncomment to set. Defaults to all rooms. + #room_name: Stack Builders Website Dev The `start_date` and `end_date` variables are inclusive (that is, if your end date is Dec 31, 2010, a transcript for that date will be downloaded), and both are optional. If they are omitted, export will run from the date each Campfire room was created, until the date of the last message in that room.