Skip to content

Commit e74cb4c

Browse files
authored
Merge pull request #445 from Walther/431-documentation-mention-features-attributes
Documentation: Add "Getting Started" section to Readme and lib.rs.
2 parents 0309d95 + e54141b commit e74cb4c

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,15 @@
4444
A modular web framework built around async/await. It's actively being developed
4545
and **not ready for production yet**.
4646

47+
## Getting started
48+
49+
Add two dependencies to your project's `Cargo.toml` file: `tide` itself, and `async-std` with the feature `attributes` enabled:
50+
```toml
51+
# Example, use the version numbers you need
52+
tide = "0.7.0"
53+
async-std = { version = "1.5.0", features = ["attributes"] }
54+
```
55+
4756
## Examples
4857

4958
**Hello World**

src/lib.rs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,15 @@
1212
//! - __Minimal:__ With only a few concepts to learn, Tide is easy to pick up and become productive
1313
//! with.
1414
//!
15+
//! # Getting started
16+
//!
17+
//! Add two dependencies to your project's `Cargo.toml` file: `tide` itself, and `async-std` with the feature `attributes` enabled:
18+
//! ```toml
19+
//!# Example, use the version numbers you need
20+
//!tide = "0.7.0"
21+
//!async-std = { version = "1.5.0", features = ["attributes"] }
22+
//!```
23+
//!
1524
//! # Examples
1625
//!
1726
//! __hello world__

0 commit comments

Comments
 (0)