Skip to content

Commit

Permalink
Improve the documentation portion of the README.md.
Browse files Browse the repository at this point in the history
Let's start with the more important _Getting started_ information, then
point the users to the documentation.
  • Loading branch information
abernix committed Feb 26, 2019
1 parent 09b4052 commit 7e506b8
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@

Apollo Server is a community-maintained open-source GraphQL server. It works with pretty much all Node.js HTTP server frameworks, and we're happy to take PRs for more! Apollo Server works with any GraphQL schema built with [GraphQL.js](https://github.com/graphql/graphql-js), so you can build your schema with that directly or with a convenience library such as [graphql-tools](https://www.apollographql.com/docs/graphql-tools/).

## Documentation

[Read the docs!](https://www.apollographql.com/docs/apollo-server/v2)

## Principles

Apollo Server is built with the following principles in mind:
Expand Down Expand Up @@ -122,6 +118,12 @@ new ApolloServer({
})
```
## Documentation

The [Apollo Server documentation](https://apollographql.com/docs/apollo-server/) contains many of the details which are necessary to get started with both GraphQL and Apollo Server.

The raw source content of that documentation is available within the `docs/` directory of this monorepo, but the _Edit on GitHub_ buttons at the bottom of each page can be used to contribute suggestions or improvements to the published content.

## Apollo Server Development

If you want to develop Apollo Server locally you must follow the following instructions:
Expand Down

0 comments on commit 7e506b8

Please sign in to comment.