Skip to content

Commit 04ba464

Browse files
committed
Documentation improvements.
Fixes #35 .
1 parent 88c3fff commit 04ba464

File tree

3 files changed

+206
-152
lines changed

3 files changed

+206
-152
lines changed

changelog.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,12 @@
1515
- Removed `package-lock.json` from `.gitignore` and `.prettierignore` as it’s disabled in `.npmrc` anyway.
1616
- Removed redundant ESLint ignore comments.
1717
- Use GitHub Actions instead of Travis for CI.
18-
- Cleaner readme “API” section table of contents with “See” and “Examples” headings excluded, thanks to [`jsdoc-md` v3.1.0](https://github.com/jaydenseric/jsdoc-md/releases/tag/v3.1.0).
19-
- Updated the readme “Apollo comparison” section “Bundle impact” subsection for the new Apollo React hooks API.
20-
- Clarify that Opera Mini isn’t supported in the Browserslist queries and readme “Support” section.
18+
- Documentation improvements, fixing [#35](https://github.com/jaydenseric/graphql-react/issues/35):
19+
- Updated the project description with better phrasing that includes the bundle size.
20+
- Moved the readme “Apollo comparison” section to the end, and updated the “Bundle impact” subsection for the new Apollo React hooks API.
21+
- Added a basic example of the core API features working together to the “Examples” section, with tips commented.
22+
- Clarified that Opera Mini isn’t supported in the Browserslist queries and readme “Support” section.
23+
- Cleaner readme “API” section table of contents with “See” and “Examples” headings excluded, thanks to [`jsdoc-md` v3.1.0](https://github.com/jaydenseric/jsdoc-md/releases/tag/v3.1.0).
2124

2225
## 8.3.0
2326

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "graphql-react",
33
"version": "8.3.0",
4-
"description": "A lightweight but powerful GraphQL client for React using modern context and hooks APIs; the first Relay and Apollo alternative with server side rendering.",
4+
"description": "A GraphQL client for React using modern context and hooks APIs that is lightweight (< 2.5 KB size limited) but powerful; the first Relay and Apollo alternative with server side rendering.",
55
"license": "MIT",
66
"author": {
77
"name": "Jayden Seric",

0 commit comments

Comments
 (0)