Add crate doc

Signed-off-by: Matthias Beyer <mail@beyermatthias.de>

1 files changed, 41 insertions, 0 deletions

diff --git a/librepology/src/lib.rs b/librepology/src/lib.rs
index 83b8184..8b4cdb3 100644
--- a/librepology/src/lib.rs
+++ b/librepology/src/lib.rs
@@ -1,2 +1,43 @@
+//! librepology
+//!
+//! This library can be used to talk to the repology API.
+//!
+//! # Example
+//!
+//! ```
+//! use librepology::endpoint::DefaultEndpoint;
+//! use librepology::v1::api::ApiClient;
+//! use librepology::v1::api::ToRequest;
+//! use librepology::v1::types::response::Problem;
+//!
+//! # async fn result_main() -> librepology::v1::error::Result<()> {
+//! ApiClient::new::<DefaultEndpoint>()?
+//!     .problems()
+//!     .for_repo(String::from("freebsd")) // sorry guys, you're the example here
+//!     .to_request()
+//!     .perform()
+//!     .await?
+//!     .into_iter()
+//!     .for_each(|problem| println!("Problem: {:?}", problem));
+//! # Ok(())
+//! # }
+//! ```
+//!
+//! # Details
+//!
+//! The `ApiClient` type is the type you need to talk to repology. It is generic over a endpoint
+//! URI, which can be set via a implementor of `librepology::endpoint::EndpointUrl`.
+//!
+//! The entry points for building an API request are `ApiClient::problems()` and
+//! `ApiClient::project()`. They return builder-pattern objects that can be used to build the
+//! request.
+//!
+//! After all parameters of the request are set, the `ToRequest::to_request()` function can be used
+//! to transform the builder into a `librepology::v1::api::Request`, that can be (async) `Request::perform()`ed.
+//!
+//! The `Request::perform()` returns the appropriate type for your request, so if you
+//! called `ApiClient::problems()` it does the right thing and returns a `Vec<Problem>`.
+//!
+
 pub mod v1;
 pub mod endpoint;