Skip to content

Commit

Permalink
User README as canonical introduction
Browse files Browse the repository at this point in the history
  • Loading branch information
Mathew Byrne committed Mar 4, 2019
1 parent 6cb9e40 commit b5360dd
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 29 deletions.
1 change: 1 addition & 0 deletions docs/content/_introduction.md
29 changes: 0 additions & 29 deletions docs/content/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,3 @@ title: Type-safe GraphQL for Go
type: homepage
date: 2018-03-17T13:06:47+11:00
---

## What is gqlgen?

[gqlgen](https://github.com/99designs/gqlgen) is a Go library for building GraphQL servers without any fuss. gqlgen is:

- **Schema first** — Define your API using the GraphQL [Schema Definition Language](http://graphql.org/learn/schema/).
- **Type safe** — You should never see `map[string]interface{}` here.
- **Codegen** — Let us generate the boring bits, so you can build your app quickly.

[Feature Comparison]({{< ref "feature-comparison.md" >}})

## Getting Started

First work your way through the [Getting Started]({{< ref "getting-started.md" >}}) tutorial.

If you can't find what your looking for, look at our [examples](https://github.com/99designs/gqlgen/tree/master/example) for example usage of gqlgen.

## Reporting Issues

If you think you've found a bug, or something isn't behaving the way you think it should, please raise an [issue](https://github.com/99designs/gqlgen/issues) on GitHub.

## Contributing

Read our [Contribution Guidelines](https://github.com/99designs/gqlgen/blob/master/CONTRIBUTING.md) for information on how you can help out gqlgen.

## Talks & Blog Posts

- [Christopher Biscardi @ Gophercon UK 2018](https://youtu.be/FdURVezcdcw)
- [Introducing gqlgen: a GraphQL Server Generator for Go](https://99designs.com.au/blog/engineering/gqlgen-a-graphql-server-generator-for-go/)
5 changes: 5 additions & 0 deletions docs/layouts/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@ <h1>{{ .LinkTitle }}</h1>
<main>
<div class="content">
{{ .Content }}
{{.Scratch.Set "intro" (readFile "content/_introduction.md")}}
{{.Scratch.Set "intro" (split (.Scratch.Get "intro") "\n")}}
{{.Scratch.Set "intro" (after 2 (.Scratch.Get "intro"))}}
{{.Scratch.Set "intro" (delimit (.Scratch.Get "intro") "\n")}}
{{.Scratch.Get "intro"|markdownify}}
</div>
</main>
{{ end }}
Expand Down

0 comments on commit b5360dd

Please sign in to comment.