Skip to content

Commit

Permalink
some more docs
Browse files Browse the repository at this point in the history
add dependencies
  • Loading branch information
OlMi1 authored Feb 18, 2023
1 parent f8d3217 commit 383bafa
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,22 @@
Python program to read data from the [Monero P2Pool](https://github.com/SChernykh/p2pool) Log File

## Usage
**Calling the reader**
### Dependencies
Not really a necessary step since all dependencies should already be there. However you may not use them in your project, so here you go:
- time
- datetime
- os
- json (for debugging)

### Calling the reader

Doing `P2PoolIO.read()` anywhere will give you the readout result. You can also do
```
foo = P2PoolIO
data = foo.read()
```

**Possible arguments:**
### Possible arguments:
- `path` (default: p2pool.log - must point to p2pool.log)
- `returnLines` (default: False)
- `linelimit` (default: 100)
Expand Down

0 comments on commit 383bafa

Please sign in to comment.