Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/simonjefford/rdayone
A ruby gem for accessing Day One (http://dayoneapp.com/) journals
https://github.com/simonjefford/rdayone
Last synced: 17 days ago
JSON representation
A ruby gem for accessing Day One (http://dayoneapp.com/) journals
- Host: GitHub
- URL: https://github.com/simonjefford/rdayone
- Owner: simonjefford
- License: mit
- Created: 2012-08-17T08:59:06.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2012-09-07T13:04:27.000Z (over 12 years ago)
- Last Synced: 2024-08-09T16:54:45.447Z (4 months ago)
- Language: Ruby
- Size: 145 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- project-awesome - simonjefford/rdayone - A ruby gem for accessing Day One (http://dayoneapp.com/) journals (Ruby)
README
# Rdayone
Rdayone is a simple Ruby library for accessing Day One journals.
[![Build Status](https://secure.travis-ci.org/simonjefford/rdayone.png)](http://travis-ci.org/simonjefford/rdayone)
## Installation
Add this line to your application's Gemfile:
gem 'rdayone'
And then execute:
$ bundle
Or install it yourself as:
$ gem install rdayone
## Usage
``` ruby
require "rdayone"
journal = Rdayone::Journal.new("/path/to/Journal.dayone")
journal.entries # An Enumerable array like object that contains all your entries
```## Supported features
* Basic entry data - text, creation date and the photo if one exists.
* Entry location data
* Sorting of entry data (default is ascending date order - a method is
supplied to sort by descending date order)## Supported rubies
1.8.7, 1.9.2, rbx and jruby
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request