graphql-php/README.md

36 lines
1.7 KiB
Markdown
Raw Normal View History

2015-07-15 19:51:22 +03:00
# graphql-php
2015-10-17 21:55:12 +03:00
[![Build Status](https://travis-ci.org/webonyx/graphql-php.svg?branch=master)](https://travis-ci.org/webonyx/graphql-php)
2018-06-16 01:04:32 +03:00
[![Quality Score](https://scrutinizer-ci.com/g/webonyx/graphql-php/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/webonyx/graphql-php)
[![Code Coverage](https://scrutinizer-ci.com/g/webonyx/graphql-php/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/webonyx/graphql-php)
[![Latest Stable Version](https://poser.pugx.org/webonyx/graphql-php/version)](https://packagist.org/packages/webonyx/graphql-php)
[![License](https://poser.pugx.org/webonyx/graphql-php/license)](https://packagist.org/packages/webonyx/graphql-php)
2015-10-17 21:55:12 +03:00
This is a PHP implementation of the GraphQL [specification](https://github.com/facebook/graphql)
based on the [reference implementation in JavaScript](https://github.com/graphql/graphql-js).
## Installation
Via composer:
```
composer require webonyx/graphql-php
```
## Documentation
2017-08-22 13:11:48 +03:00
Full documentation is available on the [Documentation site](http://webonyx.github.io/graphql-php/) as well
as in the [docs](docs/) folder of the distribution.
If you don't know what GraphQL is, visit this [official website](http://graphql.org)
by the Facebook engineering team.
## Examples
2017-08-22 13:11:48 +03:00
There are several ready examples in the [examples](examples/) folder of the distribution with specific
README file per example.
## Contribute
Please refer to [CONTRIBUTING.md](CONTRIBUTING.md) for information on how to contribute.
2017-08-22 13:11:48 +03:00
## Old README.md
Here is a [link to the old README.md](https://github.com/webonyx/graphql-php/blob/v0.9.14/README.md).
2017-08-22 13:11:48 +03:00
Keep in mind that it relates to the version 0.9.x. It may contain outdated information for
newer versions (even though we try to preserve backwards compatibility).