README.md in citeproc-ruby-0.0.6 vs README.md in citeproc-ruby-1.0.0
- old
+ new
@@ -1,92 +1,48 @@
CiteProc-Ruby
=============
+CiteProc-Ruby is a [Citation Style Language](http://citationstyles.org/) (CSL)
+1.0.1 cite processor written in pure Ruby. This Ruby gem contains the
+processor's rendering engine only; for more documentation on the whole
+cite processor, please refer to the documentation of the
+[citeproc](https://rubygems.org/gems/citeproc) gem instead.
-CiteProc-Ruby is a CSL 1.0 ([Citation Style Language](http://citationstyles.org/))
-Processor written in Ruby.
+[](http://travis-ci.org/inukshuk/citeproc-ruby)
+[](https://coveralls.io/r/inukshuk/citeproc-ruby?branch=master)
+[](https://gemnasium.com/inukshuk/citeproc-ruby)
-A word of caution: this release of CiteProc-Ruby is purely experimental; the API
-is not complete and liable to change frequently. This release is expected to
-work in Ruby version 1.9.2. only. CiteProc-Ruby currently passes approximately
-350 of the 550 tests in the citeproc-test suite.
+Development
+-----------
+The CiteProc-Ruby source code is
+[hosted on GitHub](https://github.com/inukshuk/citeproc-ruby).
+You can check out a copy of the latest code using Git:
-Note: the citeproc-ruby gem is going to be integrated with the separate `citeproc`
-and `citeproc-js` gems; meanwhile, however, these gems are not compatible, so if
-you want to use the current `citeproc-ruby` gem, make sure that neither of the
-other gems is installed.
+ $ git clone https://github.com/inukshuk/citeproc-ruby.git
-Unicode support may be provided by the `unicode-utils` gem (on Ruby 1.9 only),
-by ActiveSupport, by the `unicode` gem (on Ruby 1.8 only), by the Java-based
-support in JRuby, or naively by the `upcase` and `downcase` methods present
-in Ruby by default. These gems are not installed automatically; install one
-manually if you want enhanced Unicode support.
+To get started, install the development dependencies and run all tests:
+ $ cd citeproc-ruby
+ $ bundle install
+ $ rake
-Quickstart
-----------
+If you've found a bug or have a question, please open an issue on the
+[issue tracker](https://github.com/inukshuk/citeproc-ruby/issues).
+Or, for extra credit, clone the CiteProc-Ruby repository, write a failing
+example, fix the bug and submit a pull request.
- $ [sudo] gem install citeproc-ruby
- $ [sudo] gem install unicode-utils # Ruby 1.9
- $ [sudo] gem install unicode # Ruby 1.8
- $ irb
- >> require 'citeproc'
- >> book = {
- 'author' => [{ 'given' => 'Edgar Allen', 'family' => 'Poe' }],
- 'title' => 'Poetry, Tales, and Selected Essays',
- 'type' => 'book',
- 'issued' => { 'date-parts' => [[1996]] },
- 'editor' => [{ 'family' => 'Quinn', 'given' => 'Patrick F.'}, { 'family' => 'Thompson', 'given' => 'G.R.' }],
- 'publisher' => 'Library of America',
- 'publisher-place' => 'New York'
- }
- >> CiteProc.process(book)
- => "Poe, E. A. (1996). Poetry, Tales, and Selected Essays. (P. F. Quinn & G. R. Thompson, Eds.). New York: Library of America."
- >> CiteProc.process(book, :format => :html)
- => "Poe, E. A. (1996). <i>Poetry, Tales, and Selected Essays</i>. (P. F. Quinn & G. R. Thompson, Eds.). New York: Library of America."
- >> CiteProc.process(book, :mode => :citation)
- => ["(Poe, 1996)"]
- >> CiteProc.process(book, :style => "https://github.com/citation-style-language/styles/raw/master/chicago-author-date.csl")
- => "Poe, Edgar Allen. 1996. Poetry, Tales, and Selected Essays. Ed. Patrick F. Quinn and G.R. Thompson. New York: Library of America."
-
-
-The RSpec examples are a valuable resource of usage examples.
-
-
Credits
-------
+Thanks to Rintze M. Zelle, Sebastian Karcher, Frank G. Bennett, Jr.,
+and Bruce D'Arcus of CSL and citeproc-js fame for their support!
-CiteProc-Ruby was written by [Sylvester Keil](http://sylvester.keil.or.at);
-thanks to the excellent documentation and specifications of the
-[CSL](http://citationstyles.org), [citeproc-js](http://bitbucket.org/fbennett/citeproc-js/wiki/Home),
-the [citeproc-test suite](https://bitbucket.org/bdarcus/citeproc-test), and the
-kind feedback and support at the [xbiblio mailing list](http://sourceforge.net/mail/?group_id=117435).
+Thanks to Google and the Berkman Center at Harvard University for supporting
+this project as part of [Google Summer of Code](https://developers.google.com/open-source/soc/).
+Copyright
+---------
+Copyright 2009-2014 Sylvester Keil. All rights reserved.
+Copyright 2012 President and Fellows of Harvard College.
+
License
-------
-
-Copyright 2009-2011 Sylvester Keil. All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
- 1. Redistributions of source code must retain the above copyright notice,
- this list of conditions and the following disclaimer.
-
- 2. Redistributions in binary form must reproduce the above copyright notice,
- this list of conditions and the following disclaimer in the documentation
- and/or other materials provided with the distribution.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER ``AS IS'' AND ANY EXPRESS OR
-IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
-EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
-INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
-BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
-OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
-NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
-EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-The views and conclusions contained in the software and documentation are
-those of the authors and should not be interpreted as representing official
-policies, either expressed or implied, of the copyright holder.
\ No newline at end of file
+CiteProc-Ruby is dual licensed under the AGPL and the FreeBSD license.