From 384a9b222a67bdcc966ed23a2c43bbbcd26db10d Mon Sep 17 00:00:00 2001 From: David Glasser Date: Tue, 2 Jan 2018 12:38:34 -0800 Subject: [PATCH] README: this no longer prints or bundles deps (#140) Fixes #139. --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ccc1c37a..863cf5e1 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,13 @@ [![Build Status](https://travis-ci.org/apollographql/graphql-tag.svg?branch=master)](https://travis-ci.org/apollographql/graphql-tag) [![Get on Slack](https://img.shields.io/badge/slack-join-orange.svg)](http://www.apollodata.com/#slack) -GraphQL printing and parsing with bundled dependencies. Includes: +Helpful utilities for parsing GraphQL queries. Includes: - `gql` A JavaScript template literal tag that parses GraphQL query strings into the standard GraphQL AST. - `/loader` A webpack loader to preprocess queries +`graphql-tag` uses [the reference `graphql` library](https://github.com/graphql/graphql-js) under the hood as a peer dependency, so in addition to installing this module, you'll also have to install `graphql-js`. + ### gql This is a template literal tag you can use to concisely write a GraphQL query that is parsed into the standard GraphQL AST: @@ -78,7 +80,7 @@ class ProductsPage extends React.Component { } ``` -### Webpack preprocessing +### Webpack preprocessing with `graphql-tag/loader` This package also includes a [webpack loader](https://webpack.js.org/concepts/loaders). There are many benefits over this approach, which saves GraphQL ASTs processing time on client-side and enable queries to be separated from script over `.graphql` files.