File tree Expand file tree Collapse file tree 4 files changed +531
-6
lines changed Expand file tree Collapse file tree 4 files changed +531
-6
lines changed Original file line number Diff line number Diff line change 12
12
13
13
Atlassian Document Format PHP Tools
14
14
15
- The purpose of ` adf-tools ` is to provide an easy way to build and parse documents using Atlassian Document Format.
15
+ The purpose of ` adf-tools ` is to provide an easy way to build, parse and export documents based on Atlassian Document Format.
16
16
17
-
18
- ## Official Documentation
19
- ` adf-tools ` official documentation can be found [ here] ( ) .
17
+ ## Documentation
18
+ - Documentation of this library can be found [ here] ( doc/index.md ) .
19
+ - [ Official Atlassian Document Format] ( https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/ )
20
+ - [ Atlassian Document Format JSON Schema
] ( https://unpkg.com/@atlaskit/[email protected] /dist/json-schema/v1/full.json )
20
21
21
22
22
23
## Version Information
23
24
| Version | Status | Requirements | Badges |
24
25
| :--------| :----------------------------| :-------------| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
25
26
| 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 ) |
26
27
27
- Changelog is available [ here] ( )
28
+ Changelog is available [ here] ( https://github.com/DamienHarper/adf-tools/releases )
28
29
29
30
30
31
## Contributing
31
32
` adf-tools ` is an open source project. Contributions made by the community are welcome.
32
33
Send us your ideas, code reviews, pull requests and feature requests to help us improve this project.
33
34
34
35
Do not forget to provide unit tests when contributing to this project.
35
- To do so, follow instructions in this dedicated [ README] ( tests/README .md)
36
+ To do so, follow instructions in this dedicated [ README] ( doc/contributing .md)
36
37
37
38
38
39
## Credits
You can’t perform that action at this time.
0 commit comments