Skip to content

Commit

Permalink
Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
DamienHarper committed Sep 22, 2022
1 parent 78a4e47 commit 29a37dc
Show file tree
Hide file tree
Showing 4 changed files with 531 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,27 +12,28 @@

Atlassian Document Format PHP Tools

The purpose of `adf-tools` is to provide an easy way to build and parse documents using Atlassian Document Format.
The purpose of `adf-tools` is to provide an easy way to build, parse and export documents based on Atlassian Document Format.


## Official Documentation
`adf-tools` official documentation can be found [here]().
## Documentation
- Documentation of this library can be found [here](doc/index.md).
- [Official Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/)
- [Atlassian Document Format JSON Schema](https://unpkg.com/@atlaskit/[email protected]/dist/json-schema/v1/full.json)


## Version Information
| Version | Status | Requirements | Badges |
|:--------|:----------------------------|:-------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 1.x | Active development :rocket: | PHP >= 7.4 | [![adf-tools 1.x CI](https://github.com/DamienHarper/adf-tools/actions/workflows/ci-1.x.yml/badge.svg)](https://github.com/DamienHarper/adf-tools/actions/workflows/ci-1.x.yml) <br/>[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/DamienHarper/adf-tools/badges/quality-score.png?b=main)](https://scrutinizer-ci.com/g/DamienHarper/adf-tools/?branch=main) <br/>[![codecov](https://codecov.io/gh/DamienHarper/adf-tools/branch/main/graph/badge.svg)](https://app.codecov.io/gh/DamienHarper/adf-tools/branch/main) |

Changelog is available [here]()
Changelog is available [here](https://github.com/DamienHarper/adf-tools/releases)


## Contributing
`adf-tools` is an open source project. Contributions made by the community are welcome.
Send us your ideas, code reviews, pull requests and feature requests to help us improve this project.

Do not forget to provide unit tests when contributing to this project.
To do so, follow instructions in this dedicated [README](tests/README.md)
To do so, follow instructions in this dedicated [README](doc/contributing.md)


## Credits
Expand Down
Loading

0 comments on commit 29a37dc

Please sign in to comment.