2016-07-09 14:09:27 +00:00
# UniDoc
2016-07-13 14:15:56 +00:00
[UniDoc ](http://unidoc.io ) is a fast and powerful open source library for document manipulation starting off as a PDF
2017-01-05 13:03:12 +00:00
toolkit. This is a library written and supported by the owners
2017-01-05 12:59:35 +00:00
of the [FoxyUtils.com ](https://foxyutils.com ) website.
2016-07-09 14:09:27 +00:00
2017-01-05 12:59:35 +00:00
This library is used to power many of the PDF services offered by [FoxyUtils ](https://foxyutils.com ). The goal is to extend it to
2016-07-09 14:09:27 +00:00
eventually support all of the offered services.
2016-07-09 21:21:10 +00:00
[](https://app.wercker.com/project/bykey/22b50db125a6d376080f3f0c80d085fa)
2016-07-09 15:51:29 +00:00
[](https://godoc.org/github.com/unidoc/unidoc)
2016-07-13 14:07:01 +00:00
## Installation
~~~
go get github.com/unidoc/unidoc
~~~
2017-01-05 13:05:17 +00:00
## Vendoring
For reliability, we recommend using specific versions and the vendoring capability of golang.
Check out the Releases section to see the tagged releases.
2016-07-09 15:51:29 +00:00
## Overview
2016-07-09 14:09:27 +00:00
2016-08-01 17:25:56 +00:00
* Many [features ](http://unidoc.io/features ) with documented examples.
2016-07-09 15:51:29 +00:00
* Self contained with no external dependencies
* Developer friendly
2016-08-05 11:06:00 +00:00
## Roadmap
2016-07-09 15:51:29 +00:00
2016-08-05 11:06:00 +00:00
Our [roadmap ](https://trello.com/b/JcliaYYI ) is publicly available and features can be voted upon.
2016-07-09 14:09:27 +00:00
2016-08-05 11:06:00 +00:00
## Examples
2016-07-09 15:51:29 +00:00
2016-08-05 11:06:00 +00:00
See the [unidoc-examples ](https://github.com/unidoc/unidoc-examples/tree/master ) folder.
2016-07-09 14:09:27 +00:00
2016-07-09 15:51:29 +00:00
## Copying/License
2016-07-09 14:09:27 +00:00
2016-07-29 18:00:12 +00:00
UniDoc is licensed as [AGPL][agpl] software (with extra terms as specified in our license).
2016-07-29 17:23:39 +00:00
AGPL is a free / open source software license.
This doesn't mean the software is gratis!
2017-01-05 13:03:12 +00:00
Buying a license is mandatory as soon as you develop activities
2016-07-29 17:23:39 +00:00
distributing the UniDoc software inside your product or deploying it on a network
without disclosing the source code of your own applications under the AGPL license.
These activities include:
2017-01-05 13:03:12 +00:00
* offering services as an application service provider or over-network application programming interface (API)
2017-01-04 17:58:34 +00:00
* creating/manipulating documents for users in a web/server/cloud application
2016-07-29 17:23:39 +00:00
* shipping UniDoc with a closed source product
2017-02-09 15:04:48 +00:00
Please see [pricing ](http://unidoc.io/pricing ) to purchase a commercial license or contact sales at sales@unidoc .io for more info.
2016-07-09 14:09:27 +00:00
## Contributing
Contributors need to approve the [Contributor License Agreement ](https://docs.google.com/a/owlglobal.io/forms/d/1PfTjEAi67-x0JOTU45SDonJnWy1fWB_J1aopGss34bY/viewform ) before any code will be reviewed. Preferably add a test case to make sure there is no regression and that the new behaviour is as expected.
## Support
2016-08-03 10:48:41 +00:00
Please email us at support@unidoc .io for any queries.
2016-07-15 11:13:30 +00:00
## Stay up to date
* Follow us on [twitter ](https://twitter.com/unidoclib )
* Sign-up for our [newsletter ](http://eepurl.com/b9Idt9 )
2016-07-29 17:23:39 +00:00
[agpl]: LICENSE.md
[contributing]: CONTRIBUTING.md
