From ddfbfa1aceeb491fe89b5130bcbb65975c5dba75 Mon Sep 17 00:00:00 2001
From: tison <wander4096@gmail.com>
Date: Fri, 2 Aug 2024 17:52:44 +0800
Subject: [PATCH] docs: add more content to README (#25)

Signed-off-by: tison <wander4096@gmail.com>
---
 README.md | 49 ++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 48 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 8040f76..07df37a 100644
--- a/README.md
+++ b/README.md
@@ -14,6 +14,53 @@
 [actions-badge]: https://github.com/tisonkun/logforth/workflows/CI/badge.svg
 [actions-url]:https://github.com/tisonkun/logforth/actions?query=workflow%3ACI
 
+## Overview
+
 A versatile and extensible logging implementation.
 
-The name comes from an antonym to the [Logback](https://logback.qos.ch/) project.
+## Usage
+
+Add the dependency to your `Cargo.toml` with:
+
+```shell
+cargo add logforth
+```
+
+Then, you can use the logger with:
+
+```rust
+use log::LevelFilter;
+use logforth::append;
+use logforth::layout::TextLayout;
+use logforth::Dispatch;
+use logforth::Logger;
+
+fn main() {
+    Logger::new().dispatch(
+        Dispatch::new()
+            .filter(LevelFilter::Trace)
+            .layout(TextLayout::default())
+            .append(append::Stdout),
+        )
+        .apply()
+        .unwrap();
+
+    log::error!("Hello error!");
+    log::warn!("Hello warn!");
+    log::info!("Hello info!");
+    log::debug!("Hello debug!");
+    log::trace!("Hello trace!");
+}
+```
+
+Read more demos under the [examples](examples) directory.
+
+## Supported Rust Versions (MSRV 1.71)
+
+Logforth is built against the latest stable release. The minimum supported version is 1.71. The current Logforth version is not guaranteed to build on Rust versions earlier than the minimum supported version.
+
+## License and Origin
+
+This project is licensed under [Apache License, Version 2.0](LICENSE).
+
+The name `Logforth` comes from an antonym to the [`Logback`](https://logback.qos.ch/) project.