Skip to content

Commit 852a191

Browse files
authored
Document versioning and @api backwards compatibility guarantees (#855)
1 parent 6239765 commit 852a191

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# graphql-php
2+
23
![CI](https://github.com/webonyx/graphql-php/workflows/CI/badge.svg)
34
[![Coverage Status](https://codecov.io/gh/webonyx/graphql-php/branch/master/graph/badge.svg)](https://codecov.io/gh/webonyx/graphql-php/branch/master)
45
[![Latest Stable Version](https://poser.pugx.org/webonyx/graphql-php/version)](https://packagist.org/packages/webonyx/graphql-php)
@@ -7,21 +8,33 @@ This is a PHP implementation of the GraphQL [specification](https://github.com/f
78
based on the [reference implementation in JavaScript](https://github.com/graphql/graphql-js).
89

910
## Installation
11+
1012
Via composer:
11-
```
13+
14+
```sh
1215
composer require webonyx/graphql-php
1316
```
1417

1518
## Documentation
16-
Full documentation is available on the [Documentation site](https://webonyx.github.io/graphql-php/) as well
17-
as in the [docs](docs/) folder of the distribution.
19+
20+
Full documentation is available at [https://webonyx.github.io/graphql-php](https://webonyx.github.io/graphql-php)
21+
or in the [docs](docs) directory.
1822

1923
If you don't know what GraphQL is, visit the [official website](http://graphql.org) first.
2024

2125
## Examples
22-
There are several ready examples in the [examples](examples) folder of the distribution,
26+
27+
There are several ready examples in the [examples](examples) directory,
2328
with a specific README file per example.
2429

30+
## Versioning
31+
32+
This project follows [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html).
33+
34+
Elements that belong to the public API of this package are marked with the `@api` PHPDoc tag.
35+
Those elements are thus guaranteed to be stable within major versions. All other elements are
36+
not part of this backwards compatibility guarantee and may change between minor or patch versions.
37+
2538
## Contributors
2639

2740
This project exists thanks to [all the people](https://github.com/webonyx/graphql-php/graphs/contributors) who contribute. [[Contribute](CONTRIBUTING.md)].

0 commit comments

Comments
 (0)