Skip to content

Commit 672cd77

Browse files
fix: modify README.md
1 parent 346ac79 commit 672cd77

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# NetDriver
2+
23
<a name="top"></a>
34

45
[![Python](https://img.shields.io/badge/Python-3.12%2B-blue.svg)](https://www.python.org/)
@@ -19,7 +20,8 @@
1920
[![Share](https://img.shields.io/badge/share-FF4500?logo=reddit&logoColor=white)](https://www.reddit.com/submit?title=Check%20out%20this%20project%20on%20GitHub:%20https://github.com/Abblix/Oidc.Server)
2021
[![Share](https://img.shields.io/badge/share-0088CC?logo=telegram&logoColor=white)](https://t.me/share/url?url=https://github.com/Abblix/Oidc.Server&text=Check%20out%20this%20project%20on%20GitHub)
2122

22-
# Table of Contents
23+
## Table of Contents
24+
2325
- [About](#about)
2426
- [Updates](#updates)
2527
- [Comparison](#comparison)
@@ -30,6 +32,7 @@
3032
- [Contacts](#contacts)
3133

3234
## About
35+
3336
Everyone loves netmiko cause it's the best at what it can do, so instead of reinventing the wheel we decided to add couple of sticks in to it by implementing some Quality-of-life features.
3437
NetDriver is a network device automation framework that enables CLI command execution through HTTP RESTful APIs.
3538
With features like session persistence for efficiency a command queue to avoid configuration conflicts and an HTTP RESTful API for simple third-party integration. With its plugin architecture which combines automation scalability and contemporary network management in a single framework it offers high concurrency and is built on top of AsyncSSH
@@ -61,11 +64,9 @@ Features:
6164
| **Open source** |||
6265
| **AsyncSSH-based architecture for high concurrency** |||
6366

64-
65-
6667
## Project Structure
6768

68-
```
69+
```Text
6970
netdriver/
7071
├── bases/
7172
│ └── netdriver/
@@ -179,6 +180,7 @@ poetry self add poetry-polylith-plugin
179180
```
180181

181182
> References:
183+
>
182184
> - <https://python-poetry.org/docs/#installing-with-the-official-installer>
183185
> - <https://davidvujic.github.io/python-polylith-docs/>
184186
@@ -198,7 +200,7 @@ poetry run agent
198200

199201
Once the Agent service is started, you can access the FastAPI OpenAPI interface through a web browser to test API calls.
200202

201-
http://localhost:8000/docs
203+
<http://localhost:8000/docs>
202204

203205
![alt text](./docs/imgs/openapi.png)
204206

@@ -241,7 +243,7 @@ Run integration tests only:
241243
poetry run pytest -m integration
242244
```
243245

244-
##🤝 Contributions and Requests
246+
## 🤝 Contributions and Requests
245247

246248
Your contributions matter!Our project can always be better so we would be happy to recive your help!Please take a look at [contributing](./CONTRIBUTING.md) guide before submiting a pull request!
247249
For questions, issues, or feature requests, please open an issue on the project repository.
@@ -255,18 +257,16 @@ For questions, issues, or feature requests, please open an issue on the project
255257

256258
## Support
257259

258-
259-
260260
## 📃 License
261261

262262
This project is licensed under the [Apache License 2.0](LICENSE).
263263

264264
## Authors
265265

266-
267-
268-
269-
266+
267+
268+
269+
270270

271271
## 🗨️ Contacts
272272

0 commit comments

Comments
 (0)