Skip to content

Commit 218d625

Browse files
committed
chore: update readme
1 parent 45fe971 commit 218d625

File tree

6 files changed

+13
-63
lines changed

6 files changed

+13
-63
lines changed

.github/workflows/deploy-docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: Deploy VitePress site to Pages
22

33
on:
44
push:
5-
branches: [main]
5+
branches: [vitepress]
66
workflow_dispatch:
77

88
permissions:

README.md

Lines changed: 6 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -22,65 +22,15 @@ A Rust library that brings [ConnectRPC](https://connectrpc.com/) protocol suppor
2222
- Automatic content negotiation (JSON/binary protobuf)
2323
- All protocols served on the same port
2424

25-
## Quick Start
26-
27-
Add to your `Cargo.toml`:
28-
29-
```toml
30-
[dependencies]
31-
connectrpc-axum = "*"
32-
axum = "0.8"
33-
prost = "0.14"
34-
pbjson = "0.8"
35-
tokio = { version = "1", features = ["full"] }
36-
37-
[build-dependencies]
38-
connectrpc-axum-build = "*"
39-
```
40-
41-
Create `build.rs`:
42-
43-
```rust
44-
fn main() -> Result<(), Box<dyn std::error::Error>> {
45-
connectrpc_axum_build::compile_dir("proto").compile()?;
46-
Ok(())
47-
}
48-
```
49-
50-
Define handlers:
51-
52-
```rust
53-
use connectrpc_axum::prelude::*;
54-
55-
async fn say_hello(
56-
ConnectRequest(req): ConnectRequest<HelloRequest>,
57-
) -> Result<ConnectResponse<HelloResponse>, ConnectError> {
58-
Ok(ConnectResponse(HelloResponse {
59-
message: format!("Hello, {}!", req.name.unwrap_or_default()),
60-
}))
61-
}
62-
63-
#[tokio::main]
64-
async fn main() -> Result<(), Box<dyn std::error::Error>> {
65-
let app = helloworldservice::HelloWorldServiceBuilder::new()
66-
.say_hello(say_hello)
67-
.build_connect();
68-
69-
let listener = tokio::net::TcpListener::bind("0.0.0.0:3000").await?;
70-
axum::serve(listener, app).await?;
71-
Ok(())
72-
}
73-
```
74-
7525
## Documentation
7626

77-
See the [full documentation](https://phlx-io.github.io/connectrpc-axum/) for:
27+
📖 **[Full Documentation](https://washanhanzi.github.io/connectrpc-axum/)**
7828

79-
- [Getting Started](https://phlx-io.github.io/connectrpc-axum/guide/)
80-
- [MakeServiceBuilder](https://phlx-io.github.io/connectrpc-axum/guide/configuration)
81-
- [HTTP Endpoints](https://phlx-io.github.io/connectrpc-axum/guide/http-endpoints)
82-
- [Tonic gRPC Integration](https://phlx-io.github.io/connectrpc-axum/guide/tonic)
83-
- [build.rs Configuration](https://phlx-io.github.io/connectrpc-axum/guide/build)
29+
- [Getting Started](https://washanhanzi.github.io/connectrpc-axum/guide/)
30+
- [MakeServiceBuilder](https://washanhanzi.github.io/connectrpc-axum/guide/configuration)
31+
- [HTTP Endpoints](https://washanhanzi.github.io/connectrpc-axum/guide/http-endpoints)
32+
- [Tonic gRPC Integration](https://washanhanzi.github.io/connectrpc-axum/guide/tonic)
33+
- [build.rs Configuration](https://washanhanzi.github.io/connectrpc-axum/guide/build)
8434

8535
## Development
8636

docs/.vitepress/config.mts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ export default defineConfig({
5252
},
5353

5454
socialLinks: [
55-
{ icon: 'github', link: 'https://github.com/phlx-io/connectrpc-axum' }
55+
{ icon: 'github', link: 'https://github.com/washanhanzi/connectrpc-axum' }
5656
],
5757

5858
footer: {
@@ -65,7 +65,7 @@ export default defineConfig({
6565
},
6666

6767
editLink: {
68-
pattern: 'https://github.com/phlx-io/connectrpc-axum/edit/main/docs/:path',
68+
pattern: 'https://github.com/washanhanzi/connectrpc-axum/edit/main/docs/:path',
6969
text: 'Edit this page on GitHub'
7070
}
7171
}

docs/guide/development.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ claude /connectrpc-axum:submit-issue "Description of your issue or feature reque
1616
claude /connectrpc-axum:test
1717
```
1818

19-
If not using Claude Code, see the corresponding skill files in [`.claude/skills/`](https://github.com/phlx-io/connectrpc-axum/tree/main/.claude/skills/) for instructions.
19+
If not using Claude Code, see the corresponding skill files in [`.claude/skills/`](https://github.com/washanhanzi/connectrpc-axum/tree/main/.claude/skills/) for instructions.
2020

2121
## Architecture
2222

23-
See [`.claude/architecture.md`](https://github.com/phlx-io/connectrpc-axum/blob/main/.claude/architecture.md) for detailed documentation on the project structure, core modules, and design decisions.
23+
See [`.claude/architecture.md`](https://github.com/washanhanzi/connectrpc-axum/blob/main/.claude/architecture.md) for detailed documentation on the project structure, core modules, and design decisions.

docs/guide/examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Examples
22

3-
See the [connectrpc-axum-examples](https://github.com/phlx-io/connectrpc-axum/tree/main/connectrpc-axum-examples) directory for complete working examples.
3+
See the [connectrpc-axum-examples](https://github.com/washanhanzi/connectrpc-axum/tree/main/connectrpc-axum-examples) directory for complete working examples.
44

55
| Example | Description |
66
|---------|-------------|

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ hero:
1111
link: /guide/
1212
- theme: alt
1313
text: GitHub
14-
link: https://github.com/phlx-io/connectrpc-axum
14+
link: https://github.com/washanhanzi/connectrpc-axum
1515

1616
features:
1717
- icon: 🔌

0 commit comments

Comments
 (0)