Skip to content

Commit 20f3c2a

Browse files
authored
Improve readme (#1789)
1 parent 99f09ed commit 20f3c2a

File tree

1 file changed

+55
-23
lines changed

1 file changed

+55
-23
lines changed

README.md

Lines changed: 55 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,38 @@
1-
<p align="center"><img src="./website/public/cover.png" width="720" /></p>
1+
<div align="center"><img src="./website/public/cover.png" width="720" /></div>
22

3-
# GraphQL Yoga
3+
<div align="center">
4+
<h3>GraphQL Yoga</h3>
5+
<h6>Fully-featured GraphQL Server with focus on easy setup, performance & great developer experience</h6>
6+
<a href="https://www.the-guild.dev/graphql/yoga-server/v3"><b>Go to documenation</b></a>
7+
</div>
48

5-
Fully-featured GraphQL Server with focus on easy setup, performance & great developer experience
9+
<br />
610

7-
[Docs](https://www.the-guild.dev/graphql/yoga-server/v3)
11+
<div align="center">
812

9-
### Installation
13+
![npm](https://badgen.net/npm/v/graphql-yoga)
14+
![bundlephobia minified size](https://badgen.net/bundlephobia/min/graphql-yoga)
15+
![bundlephobia minified+zipped size](https://badgen.net/bundlephobia/minzip/graphql-yoga)
16+
![bundlephobia treeshaking](https://badgen.net/bundlephobia/tree-shaking/graphql-yoga)
17+
![license](https://badgen.net/github/license/dotansimha/graphql-yoga)
1018

11-
```shell
19+
</div>
20+
21+
## Quick start
22+
23+
### Install
24+
25+
```sh
1226
yarn add graphql-yoga graphql
1327
```
1428

15-
### Quickstart
29+
### Start
1630

17-
Make a schema, create Yoga and start a Node server with it:
31+
Make a schema, create Yoga and start a Node server:
1832

1933
```ts
2034
import { createSchema, createYoga } from 'graphql-yoga'
21-
import { createServer } from 'http'
35+
import { createServer } from 'node:http'
2236

2337
const yoga = createYoga({
2438
schema: createSchema({
@@ -48,29 +62,47 @@ server.listen(4000)
4862
- **WHATWG Fetch API:** the core package depends on [WHATWG Fetch API](https://fetch.spec.whatwg.org/) so it can run and deploy on any environment (Serverless, Workers, Deno, Node).
4963
- **Easily Extendable:** New GraphQL-Yoga support all [`envelop`](https://www.envelop.dev) plugins.
5064

51-
## Features
65+
## [Features](https://www.the-guild.dev/graphql/yoga-server/v3)
5266

53-
- [GraphQL over HTTP spec compliant](https://github.com/graphql/graphql-over-http)
54-
- TypeScript
55-
- File upload with [GraphQL Multipart Request spec](https://github.com/jaydenseric/graphql-multipart-request-spec)
56-
- Realtime capabilities
57-
- Accepts `application/json`, `application/graphql-response+json`, `application/graphql+json`, `application/x-www-form-urlencoded`, `application/graphql` and `multipart/formdata` content-types
67+
- Fully typed with [TypeScript](https://www.typescriptlang.org)
68+
- [GraphQL over HTTP spec compliant](https://github.com/enisdenjo/graphql-http/tree/master/implementations/graphql-yoga)
69+
- [GraphiQL included](https://www.the-guild.dev/graphql/yoga-server/v3/features/graphiql)
70+
- [File uploads with GraphQL Multipart Request spec](https://www.the-guild.dev/graphql/yoga-server/v3/features/file-uploads)
71+
- [Subscriptions and realtime capabilities](https://www.the-guild.dev/graphql/yoga-server/v3/features/subscriptions)
72+
- [Automatic persisted queries](https://www.the-guild.dev/graphql/yoga-server/v3/features/automatic-persisted-queries)
73+
- [Built-in parsing and validation caching](https://www.the-guild.dev/graphql/yoga-server/v3/features/parsing-and-validation-caching)
74+
- [Testing utilities](https://www.the-guild.dev/graphql/yoga-server/v3/features/testing)
5875
- Supports [ESM](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules)
59-
- Runs everywhere: Can be deployed via `now`, `up`, AWS Lambda, Heroku etc.
76+
- Runs **everywhere**, including environments like:
77+
- [Deno](https://www.the-guild.dev/graphql/yoga-server/v3/integrations/integration-with-deno)
78+
- [Bun](https://www.the-guild.dev/graphql/yoga-server/v3/integrations/integration-with-bun)
79+
- [Cloudflare Workers](https://www.the-guild.dev/graphql/yoga-server/v3/integrations/integration-with-cloudflare-workers)
80+
- [AWS Lambda](https://www.the-guild.dev/graphql/yoga-server/v3/integrations/integration-with-aws-lambda)
81+
- [_And other..._](https://www.the-guild.dev/graphql/yoga-server/v3/integrations/z-other-environments)
82+
- [_And more..._](https://www.the-guild.dev/graphql/yoga-server/v3)
83+
84+
## [Documentation](https://www.the-guild.dev/graphql/yoga-server/v3)
85+
86+
Our [documentation website](https://www.the-guild.dev/graphql/yoga-server/v3) will help you get started.
6087

61-
### Contributing
88+
## [Examples](https://github.com/dotansimha/graphql-yoga/tree/readme/examples)
89+
90+
We've made sure developers can quickly start with GraphQL Yoga by providing a comprehensive set of examples. [See all of them in the `examples/` folder.](https://github.com/dotansimha/graphql-yoga/tree/readme/examples)
91+
92+
## [Comparison](https://www.the-guild.dev/graphql/yoga-server/v3/comparison)
93+
94+
Read more about how GraphQL Yoga compares to other servers in the ecosystem [here](https://www.the-guild.dev/graphql/yoga-server/v3/comparison).
95+
96+
## Contributing
6297

6398
If this is your first time contributing to this project, please do read our [Contributor Workflow Guide](https://github.com/the-guild-org/Stack/blob/master/CONTRIBUTING.md) before you get started off.
6499

65100
Feel free to open issues and pull requests. We're always welcome support from the community.
66101

67-
### Code of Conduct
68-
69-
Help us keep Yoga open and inclusive. Please read and follow our [
70-
of Conduct](https://github.com/the-guild-org/Stack/blob/master/CODE_OF_CONDUCT.md) as adopted from [Contributor Covenant](https://www.contributor-covenant.org/)
102+
## Code of Conduct
71103

72-
### License
104+
Help us keep Yoga open and inclusive. Please read and follow our [Code of Conduct](https://github.com/the-guild-org/Stack/blob/master/CODE_OF_CONDUCT.md) as adopted from [Contributor Covenant](https://www.contributor-covenant.org/).
73105

74-
[![GitHub license](https://img.shields.io/badge/license-MIT-lightgrey.svg?maxAge=2592000)](https://raw.githubusercontent.com/dotansimha/graphql-yoga/master/LICENSE)
106+
## License
75107

76108
MIT

0 commit comments

Comments
 (0)