ready to publish

.gitignore

@@ -1 +1,2 @@
 /target
+/.idea

src/lib.rs

@@ -1,5 +1,13 @@
-use log::error;
+//!# unwrap_or_log
+//! This crate adds functions to all [`std::results::Result<T,E>`] where E implements [`std::error::Error`] by implementing the trait [`Loggable<T>`] for them
+//!
+//! The trait [`Loggable<T>`] exposes three functions:
+//!
+//! - `unwrap_or_log`: Returns the contained value [`T`] or logs the error and panics
+//! - `log_if_error`: Log the error and returns itself
+//! - `ok_or_log`: Converts [`std::result::Result<T, E>`] to an [`Option<T>`] and logs the error if present
 
+use log::error;
 ///Trait exposing the unwrap_or_log interface
 pub trait Loggable<T> {
     ///This function should try to unwrap `self` and if it fails it logs the error and panic