Skip to content

Commit 29a37dc

Browse files
committed
Documentation
1 parent 78a4e47 commit 29a37dc

File tree

4 files changed

+531
-6
lines changed

4 files changed

+531
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,27 +12,28 @@
1212

1313
Atlassian Document Format PHP Tools
1414

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.
1616

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)
2021

2122

2223
## Version Information
2324
| Version | Status | Requirements | Badges |
2425
|:--------|:----------------------------|:-------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
2526
| 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) |
2627

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

2930

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

3435
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)
3637

3738

3839
## Credits

0 commit comments

Comments
 (0)