revision: readme

Author: DogeDark

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "dioxus-logger"
-version = "0.4.0"
+version = "0.4.1"
 edition = "2021"
 description = "A logging utility to provide a standard interface whether you're targetting web, desktop, or mobile."
 repository = "https://github.com/DogeDark/dioxus-logger"

README.md

@@ -33,9 +33,8 @@
 - [ ] Logging to a file
 - [ ] Logging to [Sentry](https://sentry.io/)?
 
-**This library is under development. Expect breaking changes.**
-
-```rust, ignore
+**This library is not finished. Breaking changes may occur.**
+```rust
 use dioxus::prelude::*;
 use log::{info, LevelFilter};
 
@@ -60,6 +59,27 @@ You can add `dioxus-logger` to your application by adding it to your dependencie
 dioxus-logger = "x.x.x"
 ```
 
+To use dioxus-logger as is, add this line before launching Dioxus, replacing ``LevelFilter::Info`` with your preferred log level.
+```rs
+dioxus_logger::init(LevelFilter::Info).expect("failed to init logger");
+```
+
+## Custom Format
+Initialize dioxus-logger using the builder:
+```rs
+dioxus_logger::DioxusLogger::new(LevelFilter::Info)
+        .use_format("[{LEVEL}] {PATH} - {ARGS}")
+        .build()
+        .expect("failed to init logger");
+```
+The available options for ``use_format`` are:
+- LEVEL - The log severity.
+- PATH - Which crate emitted the log.
+- ARGS - The text that was logged.
+- TIMESTAMP - A timestamp of when the log was emitted. Requires the ``timestamps`` feature.
+
+Surround the option with ``{}`` in the ``use_format`` method.
+
 ## License
 This project is licensed under the [MIT license].
 

src/lib.rs

@@ -19,10 +19,10 @@ pub struct DioxusLogger {
 impl DioxusLogger {
     /// Create a new [`DioxusLogger`] struct to configure and build.
     pub fn new(level_filter: LevelFilter) -> Self {
-        let format = "[{LEVEL}] {PATH} - {ARGS}]";
+        let format = "[{LEVEL}] {PATH} - {ARGS}";
 
         #[cfg(feature = "timestamps")]
-        let format = "[{TIMESTAMP} | {LEVEL}] {PATH} - {ARGS}]";
+        let format = "[{TIMESTAMP} | {LEVEL}] {PATH} - {ARGS}";
 
         Self {
             level_filter,