Skip to content

Commit eb4bbb1

Browse files
committed
Add readme and tidy up Cargo.tomls
1 parent af47335 commit eb4bbb1

4 files changed

Lines changed: 62 additions & 6 deletions

File tree

grpc-protobuf-build/Cargo.toml

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
11
[package]
22
name = "grpc-protobuf-build"
33
version = "0.9.0-alpha.1"
4-
edition = "2024"
54
authors = ["gRPC Authors"]
65
license = "MIT"
7-
publish = false
6+
homepage = "https://grpc.io"
7+
repository = "https://github.com/grpc/grpc-rust"
8+
description = "Protobuf build integration for grpc"
9+
readme = "README.md"
10+
keywords = ["rpc", "grpc", "async", "protobuf", "proto"]
11+
categories = ["web-programming", "network-programming", "asynchronous"]
812
rust-version = { workspace = true }
13+
edition = "2024"
914

1015
[dependencies]
1116
prettyplease = "0.2.35"

grpc-protobuf/Cargo.toml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
[package]
22
name = "grpc-protobuf"
33
version = "0.9.0-alpha.1"
4-
edition = "2024"
54
authors = ["gRPC Authors"]
65
license = "MIT"
6+
homepage = "https://grpc.io"
7+
repository = "https://github.com/grpc/grpc-rust"
8+
description = "Protobuf integration for the grpc crate"
9+
keywords = ["rpc", "grpc", "async", "protobuf", "proto"]
10+
categories = ["web-programming", "network-programming", "asynchronous"]
711
rust-version = { workspace = true }
8-
publish = false
12+
edition = "2024"
913

1014
[package.metadata.cargo_check_external_types]
1115
allowed_external_types = [

grpc/Cargo.toml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
11
[package]
22
name = "grpc"
33
version = "0.9.0-alpha.1"
4-
edition = "2024"
54
authors = ["gRPC Authors"]
65
license = "MIT"
6+
homepage = "https://grpc.io"
7+
repository = "https://github.com/grpc/grpc-rust"
8+
description = """
9+
The official Rust implementation of gRPC: a high performance, open source, universal RPC framework.
10+
"""
11+
keywords = ["rpc", "grpc", "async", "protobuf", "proto"]
12+
categories = ["web-programming", "network-programming", "asynchronous"]
713
rust-version = { workspace = true }
8-
publish = false
14+
edition = "2024"
915

1016
[package.metadata.cargo_check_external_types]
1117
allowed_external_types = [

grpc/README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# gRPC-Rust
2+
3+
The official Rust implementation of [gRPC], a high performance, open source,
4+
universal RPC framework.
5+
6+
> NOTE: This version is a preview and not recommended for any production
7+
> use. All APIs are unstable. Proceed at your own risk.
8+
9+
## Documentation, Examples, and Getting Started
10+
11+
Please see [our website] for everything you should need to get started using
12+
gRPC!
13+
14+
[our website]: https://grpc.io/docs/languages/rust
15+
16+
### Rust Version
17+
18+
`grpc`'s MSRV is `1.88`.
19+
20+
### Project Layout
21+
22+
- `grpc` (this crate): The core gRPC implementation.
23+
- [`protoc-gen-rust-grpc`]: The protobuf code generator binary, used with [`protoc`].
24+
- [`grpc-protobuf-build`]: Build integration for grpc protobuf code generation.
25+
- [`grpc-protobuf`]: Implementation of protobuf-over-grpc used by the generated code.
26+
27+
## License
28+
29+
This project is licensed under the [MIT license](../LICENSE) and/or the [`Apache
30+
license 2.0`](https://www.apache.org/licenses/LICENSE-2.0.txt).
31+
32+
### Contributing
33+
34+
If you'd like to contribute, please see our project's
35+
[`CONTRIBUTING.md`](../CONTRIBUTING.md) for some guidelines.
36+
37+
[gRPC]: https://grpc.io
38+
[`protoc`]: https://protobuf.dev/installation/
39+
[`protoc-gen-rust-grpc`]: ../protoc-gen-rust-grpc
40+
[`grpc-protobuf-build`]: ../grpc-protobuf-build
41+
[`grpc-protobuf`]: ../grpc-protobuf

0 commit comments

Comments
 (0)