aljaz/python-teos
1
0
Fork 0
mirror of https://github.com/aljazceru/python-teos.git synced 2026-02-01 04:34:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fixes punctuation and typos on cli/README

Browse Source
This commit is contained in:
Sergi Delgado Segura
2020-02-14 16:40:02 +01:00
parent 244c04cb0d
commit e9a9ccf440
1 changed files with 6 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
apps/cli/README.md
View File

@@ -15,9 +15,8 @@ Refer to [INSTALL.md](INSTALL.md)
#### Global options
- `-s, --server`: API server where to send the requests. Defaults to btc.pisa.watch (modifiable in \_\_init\_\_.py)
- `-p, --port` : API port where to send the requests. Defaults to 9814 (modifiable in \_\_init\_\_.py)
- `-d, --debug`: shows debug information and stores it in pisa.log
- `-s, --server`: API server where to send the requests. Defaults to https://teos.pisa.watch (modifiable in conf.py)
- `-p, --port` : API port where to send the requests. Defaults to 443 (modifiable in conf.py)
- `-h --help`: shows a list of commands or help for a specific command.
#### Commands
@@ -53,8 +52,8 @@ The API will return a `application/json` HTTP response code `200/OK` if the appo
### Alpha release restrictions
The alpha release does not have authentication, payments nor rate limiting, therefore some self imposed restrictions apply:
- `start_time` should be within the next 6 blocks `[current_time+1, current_time+6]`
- `end_time` cannot be bigger than (roughtly) a month. That is `4320 blocks`
- `start_time` should be within the next 6 blocks `[current_time+1, current_time+6]`.
- `end_time` cannot be bigger than (roughtly) a month. That is `4320` blocks on top of `start_time`.
#### Usage
@@ -70,7 +69,7 @@ if `-f, --file` **is** specified, then the command expects a path to a json file
This command is used to get information about an specific appointment from the PISA server.
**Appointment can be in three states**
**Appointment can be in three states:**
- `not_found`: meaning the locator is not recognised by the tower. This can either mean the locator is wrong, or the appointment has already been fulfilled (the PISA server does not keep track of completed appointments for now).
- `being_watched`: the appointment has been accepted by the PISA server and it's being watched at the moment. This stage means that the dispute transaction has not been seen yet, and therefore no penalty transaction has been broadcast.
@@ -144,4 +143,4 @@ or
## PISA API
If you wish to read about the underlying API, and how to write your own tool to interact with it, refer to [PISA-API.md](PISA-API.md)
If you wish to read about the underlying API, and how to write your own tool to interact with it, refer to [PISA-API.md](PISA-API.md).