2016-07-09 14:09:27 +00:00
# UniDoc
2018-02-23 14:07:26 +00:00
[UniDoc ](http://unidoc.io ) is a powerful PDF library for Go (golang). The library is written and supported by the owners of the [FoxyUtils.com ](https://foxyutils.com ) website, where the library is used to power many of the PDF services offered.
2016-07-09 14:09:27 +00:00
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)
2017-07-25 16:46:28 +00:00
## Installation
~~~
go get github.com/unidoc/unidoc/...
~~~
2016-07-09 15:51:29 +00:00
2018-02-23 14:07:26 +00:00
## Getting Rid of the Watermark - Get a License
Out of the box - unidoc is unlicensed and outputs a watermark on all pages, perfect for prototyping.
To use unidoc in your projects, you need to get a license. We have 3 license types:
* Community: For open source AGPLv3 projects
* Business Individual
* Business Unlimited
Get your license on [https://unidoc.io ](https://unidoc.io ).
2016-08-05 11:06:00 +00:00
## Examples
2016-07-09 15:51:29 +00:00
2017-07-13 17:14:06 +00:00
Multiple examples are provided in our example repository.
2017-07-25 16:46:28 +00:00
Many features for processing PDF files with [documented examples ](https://unidoc.io/examples ) on our website.
2017-07-13 17:14:06 +00:00
Contact us if you need any specific examples.
2016-07-09 14:09:27 +00:00
2017-07-25 16:46:28 +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.
2017-08-24 13:57:17 +00:00
## Licensing Information
2016-07-09 14:09:27 +00:00
2017-08-24 13:57:17 +00:00
This library (UniDoc) has a dual license, a commercial one suitable for closed source projects and an
AGPL license that can be used in open source software.
2016-07-29 17:23:39 +00:00
2017-08-24 13:57:17 +00:00
Depending on your needs, you must choose one of them and follow its policies. A detail of the policies
and agreements for each license type are available in the [LICENSE.COMMERCIAL ](LICENSE.COMMERCIAL )
and [LICENSE.AGPL ](LICENSE.AGPL ) files.
2016-07-29 17:23:39 +00:00
2017-08-24 13:57:17 +00:00
In brief, purchasing 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-08-24 13:57:17 +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.
2017-03-02 16:31:17 +00:00
## Support and consulting
2016-07-09 14:09:27 +00:00
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
2017-03-02 16:31:17 +00:00
Technical support is included with a purchase of a license, as listed on our [pricing ](http://unidoc.io/pricing ) page.
2017-07-25 14:38:36 +00:00
If you have any specific tasks that need to be done, we offer consulting in certain cases.
Please contact us with a brief summary of what you need and we will get back to you with a quote, if appropriate.
2017-03-02 16:31:17 +00:00
2016-07-29 17:23:39 +00:00
[contributing]: CONTRIBUTING.md
