Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix references to moved repos #107

Merged
merged 6 commits into from
Aug 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ With these two pieces of information in hand, the transport provides the critica

To learn more about the two modes of transport, take a look at the Connect-Web documentation on [choosing a protocol](https://connectrpc.com/docs/web/choosing-a-protocol/).

To get started with Connect-Query, simply import a transport (either [`createConnectTransport`](https://github.com/bufbuild/connect-web/blob/main/packages/connect-web/src/connect-transport.ts) or [`createGrpcWebTransport`](https://github.com/bufbuild/connect-web/blob/main/packages/connect-web/src/grpc-web-transport.ts) from [`@bufbuild/connect-web`](https://www.npmjs.com/package/@bufbuild/connect-web)) and pass it to the provider.
To get started with Connect-Query, simply import a transport (either [`createConnectTransport`](https://github.com/connectrpc/connect-es/blob/main/packages/connect-web/src/connect-transport.ts) or [`createGrpcWebTransport`](https://github.com/connectrpc/connect-es/blob/main/packages/connect-web/src/grpc-web-transport.ts) from [`@bufbuild/connect-web`](https://www.npmjs.com/package/@bufbuild/connect-web)) and pass it to the provider.

```tsx
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
Expand Down Expand Up @@ -491,7 +491,7 @@ Your Protobuf files serve as the primary input to the code generators `protoc-ge

## What is `Transport`

`Transport` is a regular JavaScript object with two methods, `unary` and `stream`. See the definition in the Connect-Web codebase [here](https://github.com/bufbuild/connect-web/blob/main/packages/connect-web/src/transport.ts). `Transport` defines the mechanism by which the browser can call a gRPC-web or Connect backend. Read more about Transport on the [connect docs](https://connectrpc.com/docs/web/choosing-a-protocol).
`Transport` is a regular JavaScript object with two methods, `unary` and `stream`. See the definition in the Connect-Web codebase [here](https://github.com/connectrpc/connect-es/blob/main/packages/connect/src/transport.ts). `Transport` defines the mechanism by which the browser can call a gRPC-web or Connect backend. Read more about Transport on the [connect docs](https://connectrpc.com/docs/web/choosing-a-protocol).

## What if I already use Connect-Web?

Expand Down Expand Up @@ -572,3 +572,13 @@ To get started, we invite you to open a pull request with an example project in
If you're not yet at the point of creating an example project, feel free to open an issue in the repository and describe your use case. We'll follow up with questions to better understand your needs.

Your input and ideas are crucial in shaping the future development of Connect-Query. We appreciate your input and look forward to hearing from you.

## Status

This project is a beta: we rely on it in production, but we may make a few
changes as we gather feedback from early adopters. Join us on [Slack](https://buf.build/links/slack)
to stay updated on future releases.

## Legal

Offered under the [Apache 2 license](/LICENSE).
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"private": true,
"name": "root",
"repository": "git@github.com:bufbuild/connect-query.git",
"repository": "git@github.com:connectrpc/connect-query-es.git",
"scripts": {
"build": "pnpm --recursive build",
"generate": "pnpm --recursive generate",
Expand Down
2 changes: 1 addition & 1 deletion packages/connect-query/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ Connect-Query is an expansion pack for [TanStack Query](https://tanstack.com/que

The procedures are defined in a [Protocol Buffer](https://developers.google.com/protocol-buffers) schema implemented by your backend, and Connect-Query generates the clients and related types to access the backend with TanStack Query. The clients support two protocols: gRPC-web, and Connect's own protocol.

To get started, head over to the [docs](https://connectrpc.com/docs/query/getting-started) for a tutorial, or take a look at [our examples](https://github.com/bufbuild/connect-query/examples) for integration with various frameworks.
To get started, head over to the [docs](https://connectrpc.com/docs/query/getting-started) for a tutorial, or take a look at [our examples](https://github.com/connectrpc/connect-query-es/examples) for integration with various frameworks.
2 changes: 1 addition & 1 deletion packages/connect-query/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
},
"repository": {
"type": "git",
"url": "https://github.com/bufbuild/connect-query.git",
"url": "https://github.com/connectrpc/connect-query-es.git",
"directory": "packages/connect-query"
},
"scripts": {
Expand Down
2 changes: 1 addition & 1 deletion packages/generated-react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"sideEffects": false,
"repository": {
"type": "git",
"url": "https://github.com/bufbuild/connect-query.git",
"url": "https://github.com/connectrpc/connect-query-es.git",
"directory": "packages/protoc-gen-connect-query"
},
"files": [
Expand Down
6 changes: 3 additions & 3 deletions packages/protoc-gen-connect-query-react/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# @bufbuild/protoc-gen-connect-query-react

**This is an experimental plugin, based on the [protoc-gen-connect-query](https://github.com/bufbuild/protoc-gen-connect-query) plugin. This plugin provides better DX while sacrificing some flexibility.**
**This is an experimental plugin, based on the [protoc-gen-connect-query](https://www.npmjs.com/package/@bufbuild/protoc-gen-connect-query) plugin. This plugin provides better DX while sacrificing some flexibility.**

Instead of generating a single entry point per method:

Expand Down Expand Up @@ -45,7 +45,7 @@ const Component = () => {

The code generator for Connect-Query, a expansion pack for [TanStack Query](https://tanstack.com/query) (react-query), that enables effortless communication with servers that speak the [Connect Protocol](https://connectrpc.com/docs/protocol).

Learn more about Connect-Query at [github.com/bufbuild/connect-query](https://github.com/bufbuild/connect-query).
Learn more about Connect-Query at [github.com/connectrpc/connect-query-es](https://github.com/connectrpc/connect-query-es).

## Installation

Expand Down Expand Up @@ -237,4 +237,4 @@ This option allows you to specify the import path for the `useQuery` hook. By d

## Example Generated Code

See [`example.proto`](https://github.com/bufbuild/connect-query/blob/main/packages/generated-react/example.proto) and [`eliza.proto`](https://github.com/bufbuild/connect-query/blob/main/packages/generated-react/eliza.proto) for example inputs, and look [here](https://github.com/bufbuild/connect-query/blob/main/packages/generated-react/dist) to see the outputs those files generate.
See [`example.proto`](https://github.com/connectrpc/connect-query-es/blob/main/packages/generated-react/example.proto) and [`eliza.proto`](https://github.com/connectrpc/connect-query-es/blob/main/packages/generated-react/eliza.proto) for example inputs, and look [here](https://github.com/connectrpc/connect-query-es/blob/main/packages/generated-react/dist) to see the outputs those files generate.
2 changes: 1 addition & 1 deletion packages/protoc-gen-connect-query-react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"sideEffects": false,
"repository": {
"type": "git",
"url": "https://github.com/bufbuild/connect-query.git",
"url": "https://github.com/connectrpc/connect-query-es.git",
"directory": "packages/protoc-gen-connect-query-react"
},
"files": [
Expand Down
4 changes: 2 additions & 2 deletions packages/protoc-gen-connect-query/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

The code generator for Connect-Query, a expansion pack for [TanStack Query](https://tanstack.com/query) (react-query), that enables effortless communication with servers that speak the [Connect Protocol](https://connectrpc.com/docs/protocol).

Learn more about Connect-Query at [github.com/bufbuild/connect-query](https://github.com/bufbuild/connect-query).
Learn more about Connect-Query at [github.com/connectrpc/connect-query-es](https://github.com/connectrpc/connect-query-es).

## Installation

Expand Down Expand Up @@ -200,4 +200,4 @@ This option exists for other plugins but is not applicable to `protoc-gen-connec

## Example Generated Code

See [`example.proto`](https://github.com/bufbuild/connect-query/blob/main/packages/generated-react/example.proto) and [`eliza.proto`](https://github.com/bufbuild/connect-query/blob/main/packages/generated-react/eliza.proto) for example inputs, and look [here](https://github.com/bufbuild/connect-query/blob/main/packages/generated-react/dist) to see the outputs those files generate.
See [`example.proto`](https://github.com/connectrpc/connect-query-es/blob/main/packages/generated-react/example.proto) and [`eliza.proto`](https://github.com/connectrpc/connect-query-es/blob/main/packages/generated-react/eliza.proto) for example inputs, and look [here](https://github.com/connectrpc/connect-query-es/blob/main/packages/generated-react/dist) to see the outputs those files generate.
2 changes: 1 addition & 1 deletion packages/protoc-gen-connect-query/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"sideEffects": false,
"repository": {
"type": "git",
"url": "https://github.com/bufbuild/connect-query.git",
"url": "https://github.com/connectrpc/connect-query-es.git",
"directory": "packages/protoc-gen-connect-query"
},
"files": [
Expand Down
Loading