Skip to content

Commit 8dc7289

Browse files
committed
add readme.md
1 parent 2e19db6 commit 8dc7289

1 file changed

Lines changed: 43 additions & 0 deletions

File tree

README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,45 @@
11
# pyproxy-sdk-py
22
Python API Client for PyProxy
3+
4+
<div align="center">
5+
<h1>pyproxy-sdk-py</h1>
6+
</div>
7+
8+
9+
**pyproxy-sdk-py** is a Python library that allows you to interact with the Pyproxy API. It is useful for retrieving data about the proxy or changing its configuration while it is running.
10+
11+
<p align="center">
12+
<img src="https://img.shields.io/github/license/pyproxytools/pyproxy-sdk-py?style=for-the-badge">
13+
<img src="https://img.shields.io/github/issues/pyproxytools/pyproxy-sdk-py?style=for-the-badge">
14+
<img src="https://img.shields.io/github/issues-closed/pyproxytools/pyproxy-sdk-py?style=for-the-badge">
15+
<br>
16+
<img src="https://img.shields.io/github/forks/pyproxytools/pyproxy-sdk-py?style=for-the-badge">
17+
<img src="https://img.shields.io/github/stars/pyproxytools/pyproxy-sdk-py?style=for-the-badge">
18+
<img src="https://img.shields.io/github/commit-activity/w/pyproxytools/pyproxy-sdk-py?style=for-the-badge">
19+
<img src="https://img.shields.io/github/contributors/pyproxytools/pyproxy-sdk-py?style=for-the-badge">
20+
<br>
21+
<img src="https://img.shields.io/pypi/v/pyproxytools-sdk?style=for-the-badge">
22+
<img src="https://img.shields.io/pypi/pyversions/pyproxytools-sdk?style=for-the-badge">
23+
</p>
24+
25+
---
26+
27+
## 📦 **Installation**
28+
29+
### Install from package
30+
```bash
31+
pip install pyproxytools-sdk
32+
```
33+
34+
## 📚 **Documentation**
35+
If you encounter any problems, or if you want to use the program in a particular way, I advise you to read the [documentation](https://github.com/pyproxytools/pyproxy-sdk-py/wiki).
36+
37+
## 📄 **License**
38+
39+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
40+
41+
## 🤝 **Contributing**
42+
43+
Contributions are welcome and appreciated! If you'd like to improve this project, feel free to fork the repository and submit a pull request. Whether it's fixing bugs, adding new features, improving documentation, or suggesting enhancements, every bit helps. Please make sure to follow the coding standards and test your changes before submitting. Let's build something great together!
44+
45+
---

0 commit comments

Comments
 (0)