Skip to content

Commit 3ea87b1

Browse files
committed
Added how to use disclaimer in readme
1 parent 039f910 commit 3ea87b1

File tree

1 file changed

+22
-4
lines changed

1 file changed

+22
-4
lines changed

README.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,30 @@
1-
# **Jup-Ag-SDK**
1+
# **Jup-Ag-SDK**
22

3-
A Python SDK for interacting with Jupiter Exchange APIs.
3+
A Python SDK for interacting with Jupiter Exchange APIs.
44

5-
## **Installation**
5+
## **Installation**
6+
To install the SDK globally from PyPI, run:
67
```sh
78
pip install jup-ag-sdk
89
```
910

10-
## **Disclaimer**
11+
## **Local Development**
12+
If you want to make changes to the SDK and test it locally:
13+
14+
1. In this project's directory, install the package in editable mode by running:
15+
```sh
16+
pip install -e .
17+
```
18+
19+
2. To use this library in another project while making changes to it, install the package from its local path in that project:
20+
```sh
21+
pip install -e /path/to/jup-ag-sdk
22+
```
23+
24+
Replace `/path/to/jup-ag-sdk` with the absolute or relative path to this project directory.
25+
26+
By installing in editable mode, any changes you make to the SDK will immediately reflect in your tests without needing to reinstall the package.
27+
28+
## **Disclaimer**
1129
🚨 **This project is a work in progress and should not be used in production systems.**
1230
Expect breaking changes as the SDK evolves.

0 commit comments

Comments
 (0)