github.com/unidoc/unidoc@v2.2.0+incompatible/README.md (about)

     1  # UniDoc
     2  
     3  [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. 
     4  
     5  [![wercker status](https://app.wercker.com/status/22b50db125a6d376080f3f0c80d085fa/s/master "wercker status")](https://app.wercker.com/project/bykey/22b50db125a6d376080f3f0c80d085fa)
     6  [![GoDoc](https://godoc.org/github.com/unidoc/unidoc?status.svg)](https://godoc.org/github.com/unidoc/unidoc)
     7  
     8  ## Installation
     9  ~~~
    10  go get github.com/unidoc/unidoc/...
    11  ~~~
    12  
    13  ## Getting Rid of the Watermark - Get a License
    14  Out of the box - unidoc is unlicensed and outputs a watermark on all pages, perfect for prototyping.
    15  To use unidoc in your projects, you need to get a license.
    16  
    17  Get your license on [https://unidoc.io](https://unidoc.io).
    18  
    19  To load your license, simply do:
    20  ```
    21  unidocLicenseKey := "... your license here ..."
    22  err := license.SetLicenseKey(unidocLicenseKey)
    23  if err != nil {
    24      fmt.Printf("Error loading license: %v\n", err)
    25      os.Exit(1)
    26  }
    27  ```
    28  
    29  ## Examples
    30  
    31  Multiple examples are provided in our example repository.
    32  Many features for processing PDF files with [documented examples](https://unidoc.io/examples) on our website.
    33  
    34  Contact us if you need any specific examples.
    35  
    36  ## Vendoring
    37  For reliability, we recommend using specific versions and the vendoring capability of golang.
    38  Check out the Releases section to see the tagged releases.
    39  
    40  ## Licensing Information
    41  
    42  This library (UniDoc) has a dual license, a commercial one suitable for closed source projects and an
    43  AGPL license that can be used in open source software.
    44  
    45  Depending on your needs, you must choose one of them and follow its policies. A detail of the policies
    46  and agreements for each license type are available in the [LICENSE.COMMERCIAL](LICENSE.COMMERCIAL)
    47  and [LICENSE.AGPL](LICENSE.AGPL) files.
    48  
    49  In brief, purchasing a license is mandatory as soon as you develop activities
    50  distributing the UniDoc software inside your product or deploying it on a network
    51  without disclosing the source code of your own applications under the AGPL license.
    52  These activities include:
    53  
    54   * offering services as an application service provider or over-network application programming interface (API)
    55   * creating/manipulating documents for users in a web/server/cloud application
    56   * shipping UniDoc with a closed source product
    57  
    58  Please see [pricing](http://unidoc.io/pricing) to purchase a commercial license or contact sales at sales@unidoc.io
    59  for more info.
    60  
    61  ## Contributing
    62  
    63  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.
    64  
    65  ## Support and consulting
    66  
    67  Please email us at support@unidoc.io for any queries.
    68  
    69  If you have any specific tasks that need to be done, we offer consulting in certain cases.
    70  Please contact us with a brief summary of what you need and we will get back to you with a quote, if appropriate.
    71  
    72  
    73  [contributing]: CONTRIBUTING.md