From: Kostya Shishkov <kostya.shishkov@gmail.com>
Date: Tue, 18 Feb 2020 17:52:13 +0000 (+0100)
Subject: core: document crate a bit
X-Git-Url: https://git.nihav.org/?a=commitdiff_plain;h=776aa7d882ea8c9988003fbfa6ca9b8e034eb65e;p=nihav.git

core: document crate a bit
---

diff --git a/nihav-core/src/lib.rs b/nihav-core/src/lib.rs
index 6ac5caf..2652c14 100644
--- a/nihav-core/src/lib.rs
+++ b/nihav-core/src/lib.rs
@@ -1,3 +1,4 @@
+//! Core functionality of NihAV intended to be used by both crates implementing format support and users.
 #[cfg(feature="decoders")]
 #[allow(clippy::cast_lossless)]
 #[allow(clippy::identity_op)]