Skip to content

Commit 897025b

Browse files
committed
add examples in README
1 parent 95e38fd commit 897025b

1 file changed

Lines changed: 11 additions & 3 deletions

File tree

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
# pyproxy-sdk-py
2-
Python API Client for PyProxy
3-
41
<div align="center">
52
<h1>pyproxy-sdk-py</h1>
63
</div>
@@ -31,6 +28,17 @@ Python API Client for PyProxy
3128
pip install pyproxytools-sdk
3229
```
3330

31+
## 🚀 **Usage Examples**
32+
33+
Simple usage examples are available in the [`examples/`](examples) directory.
34+
35+
They include:
36+
37+
* Initializing the PyProxy client
38+
* Managing filters (add, delete, retrieve)
39+
* Retrieving proxy status and settings
40+
* Handling specific errors
41+
3442
## 📚 **Documentation**
3543
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).
3644

0 commit comments

Comments
 (0)