Skip to content

Commit

Permalink
chore: add readme table of contents
Browse files Browse the repository at this point in the history
  • Loading branch information
jasonkuhrt committed Oct 26, 2020
1 parent 4f9bf6c commit c75a29a
Show file tree
Hide file tree
Showing 3 changed files with 394 additions and 7 deletions.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,38 @@ Minimal GraphQL client supporting Node and browsers for scripts or simple apps

![GitHub Action](https://github.com/prisma-labs/graphql-request/workflows/trunk/badge.svg) [![npm version](https://badge.fury.io/js/graphql-request.svg)](https://badge.fury.io/js/graphql-request)

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->


- [Features](#features)
- [Install](#install)
- [Quickstart](#quickstart)
- [Usage](#usage)
- [Node Version Support](#node-version-support)
- [Community](#community)
- [GraphQL Code Generator's GraphQL-Request TypeScript Plugin](#graphql-code-generators-graphql-request-typescript-plugin)
- [Examples](#examples)
- [Authentication via HTTP header](#authentication-via-http-header)
- [Incrementally setting headers](#incrementally-setting-headers)
- [Passing more options to `fetch`](#passing-more-options-to-fetch)
- [Using GraphQL Document variables](#using-graphql-document-variables)
- [GraphQL Mutations](#graphql-mutations)
- [Error handling](#error-handling)
- [Using `require` instead of `import`](#using-require-instead-of-import)
- [Cookie support for `node`](#cookie-support-for-node)
- [Using a custom `fetch` method](#using-a-custom-fetch-method)
- [Receiving a raw response](#receiving-a-raw-response)
- [File Upload](#file-upload)
- [Browser](#browser)
- [Node](#node)
- [FAQ](#faq)
- [Why do I have to install `graphql`?](#why-do-i-have-to-install-graphql)
- [Do I need to wrap my GraphQL documents inside the `gql` template exported by `graphql-request`?](#do-i-need-to-wrap-my-graphql-documents-inside-the-gql-template-exported-by-graphql-request)
- [What's the difference between `graphql-request`, Apollo and Relay?](#whats-the-difference-between-graphql-request-apollo-and-relay)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## Features

- Most **simple & lightweight** GraphQL client
Expand Down
2 changes: 2 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
},
"homepage": "https://github.com/prisma/graphql-request",
"scripts": {
"build:docs": "doctoc README.md --notitle",
"dev": "rm -rf dist && tsc --watch",
"dev:test": "jest --watch",
"format": "prettier --write .",
Expand Down Expand Up @@ -59,6 +60,7 @@
"apollo-server-express": "^2.18.2",
"body-parser": "^1.19.0",
"bundlesize": "^0.18.0",
"doctoc": "^1.4.0",
"dripip": "^0.10.0",
"express": "^4.17.1",
"fetch-cookie": "^0.10.1",
Expand Down
Loading

0 comments on commit c75a29a

Please sign in to comment.