Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
brandon-leapyear committed Aug 26, 2020
1 parent 7028748 commit 76db56c
Showing 1 changed file with 5 additions and 8 deletions.
13 changes: 5 additions & 8 deletions graphql-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,11 @@
![Hackage](https://img.shields.io/hackage/v/graphql-client)
[![codecov](https://codecov.io/gh/LeapYear/graphql-client/branch/master/graph/badge.svg?token=WIOxotqPTN)](https://codecov.io/gh/LeapYear/graphql-client)

A client for Haskell applications to query [GraphQL](https://graphql.org) APIs. This project comes in
two parts:

* `graphql-client`: The Haskell package that can query GraphQL APIs
* `graphql-codegen-haskell`: A NodeJS library that implements a
[`graphql-code-generator`](https://graphql-code-generator.com/) plugin to
generate a Haskell module containing Haskell types and functions that work
with the `graphql-client` library. The generated code uses the [`aeson-schemas`](http://hackage.haskell.org/package/aeson-schemas) package to define GraphQL response types, and you'd need to use the package to extract data from the response.
A client for Haskell applications to query [GraphQL](https://graphql.org) APIs. This package provides two resources:

1. A `graphql-codegen` executable that can generate Haskell definitions from input `.graphql` files

2. The `graphql-client` Haskell library providing a `runQuery` function that takes in a query type generated by `graphql-codegen`

## Quickstart

Expand Down

0 comments on commit 76db56c

Please sign in to comment.