Mirror: The highly customizable and versatile GraphQL client with which you add on features like normalized caching as you grow.
chore: cleanup readmes for the new repo (#2810)
authored by
Jovi De Croock
and committed by
GitHub
53b3e49e
f8f7430b
+23
-45
+2
-10
README.md
+2
-10
README.md
···
13
13
<a href="https://github.com/urql-graphql/urql/actions/workflows/ci.yml">
14
14
<img alt="CI Status" src="https://github.com/urql-graphql/urql/actions/workflows/ci.yml/badge.svg?branch=main" />
15
15
</a>
16
-
<a href="https://www.npmjs.com/package/urql">
16
+
<a href="https://www.npmjs.com/package/@urql/core">
17
17
<img alt="Weekly downloads" src="https://badgen.net/npm/dw/urql?color=blue" />
18
18
</a>
19
19
<a href="https://formidable.com/open-source/urql/docs/">
···
28
28
29
29
## ✨ Features
30
30
31
-
- 📦 **One package** to get a working GraphQL client in React, Preact, and Svelte
31
+
- 📦 **One package** to get a working GraphQL client in React, Preact, Vue, and Svelte
32
32
- ⚙️ Fully **customisable** behaviour [via "exchanges"](https://formidable.com/open-source/urql/docs/advanced/authoring-exchanges/)
33
33
- 🗂 Logical but simple default behaviour and document caching
34
34
- 🌱 Normalized caching via [`@urql/exchange-graphcache`](https://formidable.com/open-source/urql/docs/graphcache)
···
38
38
you can take it from getting started with your first GraphQL project all the way to building complex apps and experimenting with GraphQL clients.
39
39
40
40
**📃 For more information, [check out the docs](https://formidable.com/open-source/urql/docs/).**
41
-
42
-
## Installation
43
-
44
-
```sh
45
-
yarn add urql graphql
46
-
# or
47
-
npm install --save urql graphql
48
-
```
49
41
50
42
## 🙌 Contributing
51
43
+8
-10
docs/advanced/server-side-rendering.md
+8
-10
docs/advanced/server-side-rendering.md
···
181
181
`next-urql`. The `next-urql` package includes setup for `react-ssr-prepass` already, which automates
182
182
a lot of the complexity of setting up server-side rendering with `urql`.
183
183
184
-
We have a custom integration with [`Next.js`](https://nextjs.org/), being [`next-urql`](https://github.com/FormidableLabs/urql/tree/main/packages/next-urql)
184
+
We have a custom integration with [`Next.js`](https://nextjs.org/), being [`next-urql`](https://github.com/urql-graphql/urql/tree/main/packages/next-urql)
185
185
this integration contains convenience methods specifically for `Next.js`.
186
186
These will simplify the above setup for SSR.
187
187
···
265
265
url: 'http://localhost:3000/graphql',
266
266
exchanges: [dedupExchange, cacheExchange, ssrExchange, fetchExchange],
267
267
}),
268
-
{ ssr: true }, // Enables server-side rendering using `getInitialProps`
268
+
{ ssr: true } // Enables server-side rendering using `getInitialProps`
269
269
)(Index);
270
270
```
271
271
···
310
310
const ssrCache = ssrExchange({ isClient: false });
311
311
const client = initUrqlClient(
312
312
{
313
-
url: "your-url",
313
+
url: 'your-url',
314
314
exchanges: [dedupExchange, cacheExchange, ssrCache, fetchExchange],
315
315
},
316
316
false
···
332
332
export default withUrqlClient(
333
333
ssr => ({
334
334
url: 'your-url',
335
-
}),
335
+
})
336
336
// Cannot specify { ssr: true } here so we don't wrap our component in getInitialProps
337
337
)(Todos);
338
338
```
···
374
374
const ssrCache = ssrExchange({ isClient: false });
375
375
const client = initUrqlClient(
376
376
{
377
-
url: "", // not needed without `fetchExchange`
377
+
url: '', // not needed without `fetchExchange`
378
378
exchanges: [
379
379
dedupExchange,
380
380
cacheExchange,
···
394
394
};
395
395
}
396
396
397
-
export default withUrqlClient(
398
-
ssr => ({
399
-
url: 'your-url',
400
-
}),
401
-
)(Todos);
397
+
export default withUrqlClient(ssr => ({
398
+
url: 'your-url',
399
+
}))(Todos);
402
400
```
403
401
404
402
Direct schema execution skips one network round trip by accessing your resolvers directly
-4
exchanges/context/README.md
-4
exchanges/context/README.md
-4
exchanges/execute/README.md
-4
exchanges/execute/README.md
+1
-5
exchanges/graphcache/README.md
+1
-5
exchanges/graphcache/README.md
···
2
2
3
3
<p align="center"><strong>An exchange for normalized caching support in <code>urql</code></strong></p>
4
4
5
-
`@urql/exchange-graphcache` is a normalized cache exchange for the [`urql`](https://github.com/FormidableLabs/urql) GraphQL client.
5
+
`@urql/exchange-graphcache` is a normalized cache exchange for the [`urql`](https://github.com/urql-graphql/urql) GraphQL client.
6
6
This is a drop-in replacement for the default `cacheExchange` that, instead of document
7
7
caching, caches normalized data by keys and connections between data.
8
8
···
44
44
],
45
45
});
46
46
```
47
-
48
-
## Maintenance Status
49
-
50
-
**Active:** Formidable is actively working on this project, and we expect to continue for work for the foreseeable future. Bug reports, feature requests and pull requests are welcome.
+1
-1
exchanges/graphcache/help.md
+1
-1
exchanges/graphcache/help.md
···
2
2
3
3
If you are looking at this in a browser
4
4
5
-
- ...and your URL looks like this: `github.com/FormidableLabs/urql/blob/main/exchanges/graphcache/help.md#15`
5
+
- ...and your URL looks like this: `github.com/urql-graphql/urql/blob/main/exchanges/graphcache/help.md#15`
6
6
- ...in the URL, replace `exchanges/graphcache/help.md` with `docs/graphcache/errors.md`
7
7
- ...and keep the `#15`
8
8
- ...and then you will get help with your error!
+2
-2
exchanges/graphcache/package.json
+2
-2
exchanges/graphcache/package.json
···
4
4
"description": "A normalized and configurable cache exchange for urql",
5
5
"sideEffects": false,
6
6
"homepage": "https://formidable.com/open-source/urql/docs/graphcache",
7
-
"bugs": "https://github.com/FormidableLabs/urql/issues",
7
+
"bugs": "https://github.com/urql-graphql/urql/issues",
8
8
"license": "MIT",
9
9
"repository": {
10
10
"type": "git",
11
-
"url": "https://github.com/FormidableLabs/urql.git",
11
+
"url": "https://github.com/urql-graphql/urql.git",
12
12
"directory": "exchanges/graphcache"
13
13
},
14
14
"keywords": [
+1
-1
packages/preact-urql/README.md
+1
-1
packages/preact-urql/README.md
···
7
7
<a href="https://bundlephobia.com/result?p=@urql/preact">
8
8
<img alt="Minified gzip size" src="https://img.shields.io/bundlephobia/minzip/@urql/preact.svg?label=gzip%20size" />
9
9
</a>
10
-
<a href="https://github.com/FormidableLabs/urql/discussions">
10
+
<a href="https://github.com/urql-graphql/urql/discussions">
11
11
<img alt="GitHub Discussions: Chat With Us" src="https://badgen.net/badge/discussions/chat%20with%20us/purple" />
12
12
</a>
13
13
<br />
+3
-3
packages/site/src/constants.js
+3
-3
packages/site/src/constants.js
···
1
1
const constants = {
2
2
docsTitle: 'URQL',
3
-
githubIssues: 'https://www.github.com/FormidableLabs/urql/issues',
4
-
github: 'https://www.github.com/FormidableLabs/urql',
5
-
readme: 'https://github.com/FormidableLabs/urql/blob/main/README.md',
3
+
githubIssues: 'https://www.github.com/urql-graphql/urql/issues',
4
+
github: 'https://www.github.com/urql-graphql/urql',
5
+
readme: 'https://github.com/urql-graphql/urql/blob/main/README.md',
6
6
color: '#6B78B8',
7
7
googleAnalyticsId: 'UA-43290258-1',
8
8
};
+2
-2
packages/site/src/screens/home/hero.js
+2
-2
packages/site/src/screens/home/hero.js
···
238
238
<li>
239
239
<a
240
240
title="Issues"
241
-
href="https://www.github.com/FormidableLabs/urql/issues"
241
+
href="https://www.github.com/urql-graphql/urql/issues"
242
242
>
243
243
Issues
244
244
</a>
245
245
</li>
246
246
<li>
247
-
<a title="GitHub" href="https://github.com/FormidableLabs/urql">
247
+
<a title="GitHub" href="https://github.com/urql-graphql/urql">
248
248
GitHub
249
249
</a>
250
250
</li>
+1
-1
packages/storybook-addon/package.json
+1
-1
packages/storybook-addon/package.json
···
63
63
"access": "public"
64
64
},
65
65
"storybook": {
66
-
"icon": "https://github.com/FormidableLabs/urql/raw/main/packages/site/src/assets/sidebar-badge.svg",
66
+
"icon": "https://github.com/urql-graphql/urql/raw/main/packages/site/src/assets/sidebar-badge.svg",
67
67
"displayName": "urql"
68
68
}
69
69
}
+1
-1
packages/vue-urql/README.md
+1
-1
packages/vue-urql/README.md
···
7
7
<a href="https://bundlephobia.com/result?p=@urql/vue">
8
8
<img alt="Minified gzip size" src="https://img.shields.io/bundlephobia/minzip/@urql/vue.svg?label=gzip%20size" />
9
9
</a>
10
-
<a href="https://github.com/FormidableLabs/urql/discussions">
10
+
<a href="https://github.com/urql-graphql/urql/discussions">
11
11
<img alt="GitHub Discussions: Chat With Us" src="https://badgen.net/badge/discussions/chat%20with%20us/purple" />
12
12
</a>
13
13
<br />