Skip to content

Commit 4e8b38b

Browse files
authored
Add install section to README.md (#765)
* Add install section to README.md * Modify lib.rs and runn cargo-sync-readme
1 parent 330b786 commit 4e8b38b

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

protobuf/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,17 @@
22

33
# Library to read and write protocol buffers data
44

5+
## Install
6+
7+
To get started generaing Rust code from ProtoBufs, add this to your `Cargo.toml`
8+
```toml
9+
[dependencies]
10+
protobuf = "3.7"
11+
12+
[build-dependencies]
13+
protobuf-codegen = "3.7"
14+
```
15+
516
## Features
617

718
This crate has one feature, which is `with-bytes`.

protobuf/src/lib.rs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
//! # Library to read and write protocol buffers data
22
//!
3+
//! ## Install
4+
//!
5+
//! To get started generaing Rust code from ProtoBufs, add this to your `Cargo.toml`
6+
//! ```toml
7+
//! [dependencies]
8+
//! protobuf = "3.7"
9+
//!
10+
//! [build-dependencies]
11+
//! protobuf-codegen = "3.7"
12+
//! ```
13+
//!
314
//! ## Features
415
//!
516
//! This crate has one feature, which is `with-bytes`.

0 commit comments

Comments
 (0)