Officedoc

Gem Version GitHub version Build Status Code Climate Code Coverage Dependency Status

Parsing and constructing documents using XML-based Office formats: ODF and OOXML.

NOT FOR PUBLIC USE YET. ACTIVE INITIAL DEVELOPMENT IN PROGRESS.

Installation

Add this line to your application's Gemfile:

gem 'officedoc'

And then execute:

$ bundle

Or install it yourself as:

$ gem install officedoc

Usage

TODO: Write usage instructions here

License

Copyright (C) 2014 Andrey Pronin (https://github.com/moonfly).

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Versioning

Semantic versioning (http://semver.org/spec/v2.0.0.html) is used.

For a version number MAJOR.MINOR.PATCH, unless MAJOR is 0:

  1. MAJOR version is incremented when incompatible API changes are made,
  2. MINOR version is incremented when functionality is added in a backwards-compatible manner,
  3. PATCH version is incremented when backwards-compatible bug fixes are made.

Major version "zero" (0.y.z) is for initial development. Anything may change at any time. The public API should not be considered stable. Furthermore, version "double-zero" (0.0.x) is not intended for public use, as even minimal functionality is not guaranteed to be implemented yet.

Dependencies

TODO: List gem dependencies here

Contributing

  1. Fork it (https://github.com/moonfly/officedoc/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request