-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
78a4e47
commit 29a37dc
Showing
4 changed files
with
531 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|
Oops, something went wrong.