more docs

Signed-off-by: Adam Perkowski <[email protected]>

README.md

@@ -4,6 +4,7 @@
 🚦 fast new version checker for software releases 🦀<br>
 [nvchecker](https://github.com/lilydjwg/nvchecker) rewritten in Rust
 
+![Build Status](https://img.shields.io/github/actions/workflow/status/adamperkowski/nvrs/rust.yml?style=for-the-badge&labelColor=%23a8127d&color=%23336795) ![docs.rs](https://img.shields.io/docsrs/nvrs?style=for-the-badge&labelColor=%23a8127d&color=%23336795)
 ![GitHub Contributors](https://img.shields.io/github/contributors-anon/adamperkowski/nvrs?style=for-the-badge&labelColor=%23a8127d&color=%23336795) ![GitHub Repo Size](https://img.shields.io/github/repo-size/adamperkowski/nvrs?style=for-the-badge&labelColor=%23a8127d&color=%23336795) ![Repo Created At](https://img.shields.io/github/created-at/adamperkowski/nvrs?style=for-the-badge&labelColor=%23a8127d&color=%23336795)
 
 ![banner](/banner.webp)

src/error.rs

@@ -37,24 +37,31 @@ pub enum Error {
     #[error("{0}: version not found")]
     NoVersion(String),
 
+    /// explicitly specified configuration file not found
     #[error("specified config file not found")]
     NoConfigSpecified,
 
+    /// configuration file not found
     #[error("no config found\n{CONFIG_PATHS}")]
     NoConfig,
 
+    /// no `__config__` in the configuration file
     #[error("__config__ not specified\n{EXAMPLE_CONFIG_TABLE}")]
     NoConfigTable,
 
+    /// no `oldver` or `newver` in `__config__`
     #[error("oldver & newver not specified\n{EXAMPLE_CONFIG_TABLE}")]
     NoXVer,
 
+    /// verfile version != 2
     #[error("unsupported verfile version\nplease update your verfiles")]
     VerfileVer,
 
+    /// package not found in newver
     #[error("{0}: package not in newver")]
     PkgNotInNewver(String),
 
+    /// source / API not found
     #[error("source {0} not found")]
     SourceNotFound(String),
 }