README.md in rb-dayone-0.4.1 vs README.md in rb-dayone-0.6.0

- old
+ new

@@ -1,12 +1,12 @@ # rb-dayone -A means to create DayOne entries in ruby. Also, my first public ruby gem! +A means to create DayOne entries in ruby. ## Examples -You can create an entry pretty simply, by passing in your entry text: +You can create an entry pretty simply: e = DayOne::Entry.new "# Hello, world!" You can also set up other values via a hash: @@ -19,60 +19,112 @@ When you're ready to save your entry, just run the `create!` method: e.create! -Alternatively, run from the command line: +## Binary - dayone add --text "#Hello, world" --starred +Rb-dayone ships with a binary, `dayone`. Run `dayone --help` for instructions on how to use it. -For more information on what you can do from the command line: +## Install - dayone --help + gem install rb-dayone -### Validating and repairing doentry files ### +## Author -As of version 0.2.0 of this gem, `rb-dayone` is finally outputting *nice* XML. Before then, it wasn't. You can check if any of your DayOne entries need repairing by running: +Original author: [Jan-Yves Ruzicka](http://www.1klb.com). Get in touch [via email](mailto:jan@1klb.com). - dayone validate +## History -If they do, you might be able to fix them using: +### 0.6.0 / 2013-01-14 - dayone repair +* [NEW] Location support +* [NEW] Re-added the binary with actual functionality. +* [FIXED] No longer relies on LibXML - all Nokogiri! +* [FIXED] Imports times correctly as UTC. -If not, let me know, and I'll see what I can do to fix stuff. +### 0.5.0 / 2013-01-09 -## Install +* [NEW] Added support for tagging entries via `Entry#tag`, `Entry#tags`, and `Entry#add_tags_from_entry_text`. +* [REMOVED] Got rid of the binary. You can probably make a better library on your own. - gem install rb-dayone +## 0.4.1 / 2012-11-14 -## Author +* [FIXED] rb-dayone was looking in the wrong place for preferences +* [FIXED] new preference files not json-parseable. Swapped to XML/Nokogiri -Original author: [Jan-Yves Ruzicka](http://www.1klb.com) ([@akchizar](http://www.twitter.com/akchizar)). Get in touch [via email](mailto:janyves.ruzicka@gmail.com). +## 0.4.0 / 2012-10-22 -## To do +* Added image support -* Image support -* Location support? +## 0.3.3 / 2012-08-17 -## License +* [FIXED] LibXML will now accept UTF-8 characters in journal entries. +* Added the command "repair" to the dayone binary, which will at least repair *my* damage. +* Added the command "verify" to the dayone binary, which I at least find helpful. +* Added a post-install note telling people upgrading from <= 0.2.0 to repair. -Copyright (c) 2012 Jan-Yves Ruzicka +## 0.3.2 / 2012-08-16 -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -'Software'), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: +* Switched from REXML to LibXML-ruby for XML parsing. Now accepts ampersands in entries, as well as UTF-8. Rejoice! -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. +## 0.3.1 / 2012-08-16 -THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +* [FIXED] Minor bugfixes +* [FIXED] REXML will no longer kill the whole program if it can't parse a journal file. + +## 0.3.0 / 2012-08-16 + +* [FIXED] Fixed several bugs in Builder xml output, including: + * Output of trailing <target /> + * Output of malformed DOCTYPE +* You can now import existing DayOne entries and search them + +## 0.2.0 / 2012-08-14 + +* Now auto-detects DayOne journal location from your plist file + +## 0.1.7 / 2012-08-13 + +* The dayone binary can now add entries to your journal +* [FIXED] Managed to break the gem's include in 0.1.6, and because I'm a terrible amateur at all this, didn't pick up on it. + +## 0.1.6 / 2012-08-13 + +* Updated documentation so YARD would generate nice rdocs +* dayone binary now uses the Commander gem +* Now using a Manifest file rather than globbing in whole directories + +## 0.1.5 / 2012-08-12 + +* [FIXED] Ouch, horrid horrid gemspec and readme. Let's make them prettier. + +## 0.1.4 / 2012-08-12 + +* Added a couple more tests for better coverage + +## 0.1.3 / 2012-08-12 + +* Removed the SimpleXML class, now using the Builder gem + +## 0.1.2 / 2012-08-12 + +* [FIXED] Actual testing on my own system + +## 0.1.1 / 2012-08-07 + +* [FIXED] DayOne constants are now `attr_accessors` - set them yourself if you wish! + +## 0.1.0 / 2012-08-06 + +* Added binary +* Support for DayOne locations +* Uploaded to github! + +## 0.0.1 / 2012-08-05 + +* Started development + +## To do + +* Location support? +* Switch from using two different XML libraries to one XML library. \ No newline at end of file