📝 update readme

nonebot · Dec 21, 2024 · 60835b8 · 60835b8
1 parent 3704a87
commit 60835b8
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,15 @@
 # NoneStorage
 
 Simple library that provides local storage folder detect
+
+## Usage
+
+```python
+from pathlib import Path
+
+from nonestorage import user_data_dir, user_config_dir, user_cache_dir
+
+data_dir: Path = user_data_dir("appname")
+config_dir: Path = user_config_dir("appname", roaming=True)
+cache_dir: Path = user_cache_dir("appname", roaming=False)
+```