Skip to content

Commit

Permalink
Update README with PyPi installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
hreikin committed Nov 28, 2024
1 parent 0de624c commit 31b7448
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@ This module provides the `P2PoolAPI` object to allow interacting with the P2Pool

## Installation

The module can be installed from Github with pip:
The module can be installed from PyPi or Github with pip:

```
pip install p2pool-api
# or to install from the Github repository
pip install p2pool-api@git+https://github.com/hreikin/p2pool-api.git@main
```

Expand All @@ -23,6 +25,6 @@ x = p2pool_api.P2PoolAPI(api)

print(x._local_stratum) # Print entire reponse
print(x.local_p2p_uptime) # Print property representing individual data from the API
x.get_stats_mod() # Update individual endpoints
x.get_stats_mod() # Update individual `stats_mod` endpoint
x.get_all_data() # Update all endpoints at once
```

0 comments on commit 31b7448

Please sign in to comment.