README.md

---
license: Licensed to the Apache Software Foundation (ASF) under one
         or more contributor license agreements.  See the NOTICE file
         distributed with this work for additional information
         regarding copyright ownership.  The ASF licenses this file
         to you under the Apache License, Version 2.0 (the
         "License"); you may not use this file except in compliance
         with the License.  You may obtain a copy of the License at

           http://www.apache.org/licenses/LICENSE-2.0

         Unless required by applicable law or agreed to in writing,
         software distributed under the License is distributed on an
         "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
         KIND, either express or implied.  See the License for the
         specific language governing permissions and limitations
         under the License.
---
Apache PDFBox Documentation
===========================

Documentation Format
--------------------

All of the [Apache PDFBox](http://pdfbox.apache.org/) documentation is written with [markdown](http://daringfireball.net/projects/markdown/syntax). 

Contributing
------------

### Contribution Guidlines

As a minimum requirement all contributions shall have the [Apache License](http://www.apache.org/licenses/LICENSE-2.0.html#apply) header attached.

For larger contributions or if you are looking to contribute regulary we ask you to sign an [ICLA](http://www.apache.org/licenses/#clas).

### Report or Fix an Issue

We use [Apache JIRA](https://issues.apache.org/jira/browse/PDFBOX) as our tracking tool.

### Using Git Pull Requests

Pull requests are welcome!

We appreciate the use of topic branches.

    git checkout -b <JIRA issue number>

    # update enhance the documentation

    git commit -m "<JIRA issue number>: This is my commit message."

    git push origin <JIRA issue number>

    # issue a pull request from your branch <JIRA issue number>
    
    # wait for a committer to commit your patch