Skip to content

Commit a3642bf

Browse files
committed
docs: Update readme
1 parent b684105 commit a3642bf

File tree

1 file changed

+43
-2
lines changed

1 file changed

+43
-2
lines changed

README.md

Lines changed: 43 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,43 @@
1-
# graphql-resolver-cache
2-
Caching for Graphql Resolvers
1+
2+
Graphql resolver cache
3+
==============================
4+
5+
[![Greenkeeper badge](https://badges.greenkeeper.io/Intellicode/graphql-resolver-cache.svg)](https://greenkeeper.io/)
6+
7+
[![Maintenance Status][status-image]][status-url] [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][deps-image]][deps-url] [![Coverage Status][coverage-image]][coverage-url] [![Code Climate][climate-image]][climate-url] [![BCH compliance][bettercode-image]][bettercode-url]
8+
9+
Easy wrapper around resolvers to cache results based on root elements and Graphql query arguments.
10+
11+
# Installation
12+
13+
```sh
14+
$ npm install graphql-resolver-cache --save
15+
```
16+
17+
# Configuration
18+
19+
TODO
20+
21+
# List of supported rules
22+
23+
[npm-url]: https://npmjs.org/package/graphql-resolver-cache
24+
[npm-image]: http://img.shields.io/npm/v/graphql-resolver-cache.svg?style=flat-square
25+
26+
[travis-url]: https://travis-ci.org/Intellicode/graphql-resolver-cache
27+
[travis-image]: http://img.shields.io/travis/Intellicode/graphql-resolver-cache/master.svg?style=flat-square
28+
29+
[deps-url]: https://david-dm.org/Intellicode/graphql-resolver-cache
30+
[deps-image]: https://img.shields.io/david/dev/Intellicode/graphql-resolver-cache.svg?style=flat-square
31+
32+
[coverage-url]: https://coveralls.io/r/Intellicode/graphql-resolver-cache?branch=master
33+
[coverage-image]: http://img.shields.io/coveralls/Intellicode/graphql-resolver-cache/master.svg?style=flat-square
34+
35+
[climate-url]: https://codeclimate.com/github/Intellicode/graphql-resolver-cache
36+
[climate-image]: http://img.shields.io/codeclimate/github/Intellicode/graphql-resolver-cache.svg?style=flat-square
37+
38+
[status-url]: https://github.com/Intellicode/graphql-resolver-cache/pulse
39+
[status-image]: http://img.shields.io/badge/status-maintained-brightgreen.svg?style=flat-square
40+
41+
[bettercode-image]: https://bettercodehub.com/edge/badge/Intellicode/graphql-resolver-cache
42+
[bettercode-url]: https://bettercodehub.com
43+

0 commit comments

Comments
 (0)