diff --git a/README.md b/README.md
index f273522..4649ee0 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,50 @@
# Aioarxiv
+
+ 
+
+
+ 
+
+
+
+ 
+
+
+ 
+
+
+ 
+
+
+ 
+
+
+ 
+
+
+ 
+
+
+ 
+
+
+ 
+
+
An async Python client for the arXiv API with enhanced performance and flexible configuration options.
-> ⚠️ Warning: This project is currently in beta. Not recommended for production use.
+> [!WARNING]
+> This project is currently under development and has not yet reached a stable release. We do not recommend using it in
+> production environments.
## Features
- Asynchronous API calls for better performance
+- Customized configuration client
- Flexible search and download capabilities
- Customizable rate limiting and concurrent requests
-- Simple error handling
+- Complete type hints and documentation
## Installation
@@ -20,24 +55,41 @@ pip install aioarxiv
## Quick Start
```python
+from aioarxiv.client.arxiv_client import ArxivClient
+from aioarxiv.utils import logger
+
+
+async def func():
+ async with ArxivClient() as client:
+ result = await client.search("ai", max_results=100)
+ logger.info(f"Total results: {result.total_result}")
```
## Configuration
-```python
-```
+You can configure the client by passing an instance of `ArxivConfig` to the `ArxivClient` constructor.
+Configuration in Dotenv file is also one of the options, it will automatically load the configuration from the
+environment variables.
-## Error Handling
-
```python
+from aioarxiv.config import ArxivConfig
+
+config = ArxivConfig(
+ proxy="http://127.0.0.1:10808",
+ log_level="DEBUG",
+ page_size=10,
+)
```
## Requirements
+
* Python 3.9 or higher
## License
+
[MIT License (c) 2025 BalconyJH ](LICENSE)
## Links
-* Documentation for aioarxiv is WIP
+
+* [Documentation](https://balconyjh.github.io/aioarxiv/starter.html)
* [ArXiv API](https://info.arxiv.org/help/api/index.html)
\ No newline at end of file