NEWS

# RCite release history

## Versioning Scheme

RCite uses [Semantic Versioning](http://semver.org). Version numbers are
determined as follows:

1. Patch version increases (x.x.up) indicate bug fixes. They are always
   backwards compatible and should only improve things.
2. Minor version increases (x.up.x) indicate feature additions and larger
   changes to the code. The user API (see below) remains backwards compatible,
   while the programmer API may change.
3. Major version increases (up.x.x) indicate fundamental changes to RCite.
   Both user and programmer API may change.

Major changes to both APIs are indicated below for each version.

### User And Programmer API

Everything that is meant to be used in user-made styles belongs to the
user API. The StyleGuide is a good source: Everything mentioned there
is likely part of the user API. The same obviously applies to the `rcite`
command itself. Use `rake api` to display a complete list.

All the other public classes and methods belong to the programmer API.

## Released Versions

Note that this file is not a changelog. Not every single commit is listed here
but only the more important ones. Use `git log` to view all of them.

Version 0.1.0

* CHANGES PROGRAMMER API. Major updates:
    * Global variables are turned into class variables. See 5af4a14
    * Bibliography file entries are not represented by citeproc-format hashes
      any more, but by BibTeX::Entry objects. See 1c096a7
* Adds complete teststyle with spec.
* Defines user and programmer APIs.
* Multiline values are now turned into single lines.
* Fixes a bug where unnecessary separators would be printed at the end of
  a citation/bibliography entry under certain circumstances.

Version 0.0.1

* initial release