graphql-php/README.md

33 lines
1.6 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)
[![Coverage Status](https://coveralls.io/repos/github/webonyx/graphql-php/badge.svg)](https://coveralls.io/github/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 port of GraphQL reference implementation based on the [specification](https://github.com/facebook/graphql)
and the [reference implementation in JavaScript](https://github.com/graphql/graphql-js).
This implementation follows JavaScript version as close as possible until GraphQL itself stabilizes.
## Installation
Via composer:
```
composer require webonyx/graphql-php
```
## Documentation
Full documentation is available on [Documentation site](http://webonyx.github.io/graphql-php/) as well
as in [docs](docs/) folder of the distribution.
## Examples
There are several ready examples in [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.
## Old README
Here is a [link to Old README.md](https://github.com/webonyx/graphql-php/blob/v0.9.14/README.md).
Keep in mind though 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).