Skip to content

Commit cb0c24b

Browse files
committed
crates_io_team_repo: Add README.md
1 parent e4e79c5 commit cb0c24b

File tree

2 files changed

+13
-6
lines changed

2 files changed

+13
-6
lines changed
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# crates_io_team_repo
2+
3+
The code in this package interacts with the
4+
<https://github.com/rust-lang/team/> repository.
5+
6+
The `TeamRepo` trait is used to abstract away the HTTP client for testing
7+
purposes. The `TeamRepoImpl` struct is the actual implementation of
8+
the trait.
9+
10+
If the `mock` feature is enabled, a `MockTeamRepo` struct is available,
11+
which can be used for testing purposes. This struct is generated automatically
12+
by the [`mockall`](https://docs.rs/mockall) crate.

crates/crates_io_team_repo/src/lib.rs

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,4 @@
1-
//! The code in this module interacts with the
2-
//! <https://github.com/rust-lang/team/> repository.
3-
//!
4-
//! The [TeamRepo] trait is used to abstract away the HTTP client for testing
5-
//! purposes. The [TeamRepoImpl] struct is the actual implementation of
6-
//! the trait.
1+
#![doc = include_str!("../README.md")]
72

83
use async_trait::async_trait;
94
use reqwest::{Certificate, Client};

0 commit comments

Comments
 (0)