Example uses in README.md?

[cboettig]

Example uses in README.md?

[inukshuk]

Apologies for the late reply!

There is currently no stable release of citeproc/csl gems: you can still use citeproc-ruby 0.0.x (gem install citeproc-ruby) to format bibliographic references (i.e., for bibliographies) and simple one-off citation references. For usage examples take a look at the Readme in the legacy branch. The processor requires JSON input – if you get the XML you will have to convert it first.

Because the cite processor became way more complicated than I had anticipated I have re-written most parts of it with a much better architecture. The re-write is already pretty far advanced, but because there are so many moving parts it is a little difficult to use at the moment. Basically, the functionality has been split up into three individual gems:

• citeproc – this gem already includes a parser for the JSON data as well as many tools to help you convert or create data on the fly (like smart human name and date parsers)
• csl-ruby – this gem (currently you need to install with the --pre switch); this includes a full library for parsing and creating CSL styles and locales. You can use it to validate styles, create styles conveniently in Ruby, or query CSL locales
• citeproc-ruby – this new CSL processor based on the other two gems. This has not been released as gem yet.

We're probably 1-2 work-weeks away from an initial release right now – until then you'll have to use the legacy processor I'm afraid.