aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFuwn <[email protected]>2022-03-09 03:04:42 -0800
committerFuwn <[email protected]>2022-03-09 03:04:42 -0800
commit8564c696c2040480e93cff644a95f602f529156d (patch)
treee4751d45af2fe134f275080617294601f6506549
parentfeat(senpy): 0.1.0 :star: (diff)
downloadsenpy-rs-8564c696c2040480e93cff644a95f602f529156d.tar.xz
senpy-rs-8564c696c2040480e93cff644a95f602f529156d.zip
docs(lib): top-level doc comment
-rw-r--r--src/lib.rs6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/lib.rs b/src/lib.rs
index f1fb10d..1288e4a 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -16,6 +16,12 @@
// Copyright (C) 2022-2022 Fuwn <[email protected]>
// SPDX-License-Identifier: GPL-3.0-only
+//! # senpy-rs
+//!
+//! A wrapper of The Senpy Club API, which is a wrapper of the
+//! [cat-milk/Anime-Girls-Holding-Programming-Books](https://github.com/cat-milk/Anime-Girls-Holding-Programming-Books)
+//! repository.
+
#![deny(
warnings,
nonstandard_style,