Skip to content

Commit d1f5021

Browse files
author
Will Flores
committed
docs: update README - PyPI install, fix broken links, add badges
1 parent 46abba5 commit d1f5021

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,14 @@
55

66
**Institutional Insurance for XRPL DeFi Lending**
77

8-
[![Status: Testnet](https://img.shields.io/badge/Status-Testnet-blue)](https://wardprotocol.org)
9-
[![Tests: 75/75](https://img.shields.io/badge/Tests-75%2F75%20passing-brightgreen)](test_ward.py)
8+
[![PyPI](https://img.shields.io/pypi/v/ward-protocol?label=PyPI&color=blue)](https://pypi.org/project/ward-protocol/)
9+
[![Python 3.12](https://img.shields.io/badge/Python-3.12-3776ab)](https://www.python.org/downloads/)
1010
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
11+
[![Live API](https://img.shields.io/badge/Live%20API-online-brightgreen)](https://api.wardprotocol.org)
12+
[![Tests: 75/75](https://img.shields.io/badge/Tests-75%2F75%20passing-brightgreen)](test_ward.py)
1113
[![XRPL: Discussion](https://img.shields.io/badge/XRPL-Discussion-orange)](https://github.com/XRPLF/XRPL-Standards/discussions)
1214

13-
[Website](https://wardprotocol.org)[Documentation](https://wardprotocol.org)[Demo](https://app.wardprotocol.org)
15+
[Website](https://wardprotocol.org)[API Docs](https://api.wardprotocol.org/docs)[PyPI](https://pypi.org/project/ward-protocol/)
1416
</div>
1517

1618
---
@@ -100,15 +102,18 @@ The primary deliverable is a single self-contained Python module with five harde
100102

101103
### Installation
102104

105+
```bash
106+
pip install ward-protocol
107+
```
108+
109+
**For development** (clone + run tests):
110+
103111
```bash
104112
git clone https://github.com/wflores9/ward-protocol.git
105113
cd ward-protocol
106-
107-
# Install dependencies
108-
pip install xrpl-py>=4.0.0
114+
pip install xrpl-py pytest pytest-asyncio
109115

110116
# Run tests (unit tests only, no network required)
111-
pip install pytest pytest-asyncio
112117
pytest test_ward.py -v -m "not integration"
113118

114119
# Full testnet simulation (XRPL Altnet required)
@@ -292,6 +297,9 @@ Depositor wallet Pool wallet (institution)
292297
### Running the SDK
293298

294299
```bash
300+
pip install ward-protocol
301+
302+
# Or clone for development:
295303
git clone https://github.com/wflores9/ward-protocol.git
296304
cd ward-protocol
297305
pip install xrpl-py pytest pytest-asyncio
@@ -383,8 +391,6 @@ Ward Protocol is open source and welcomes contributions!
383391
3. Make your changes
384392
4. Submit a pull request
385393

386-
See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
387-
388394
---
389395

390396
## Community

0 commit comments

Comments
 (0)