Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

Awesome Lists containing this project

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