Skip to content

Commit c07dbd5

Browse files
author
Sebastian Machuca
committed
Adding basic documentation
1 parent 6943d0c commit c07dbd5

File tree

3 files changed

+23
-0
lines changed

3 files changed

+23
-0
lines changed

README.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,10 @@ Or to install a specific release:
197197

198198
pip install -U pymodbus==X.Y.Z
199199

200+
You can also use Docker to run a local image with the package installed on the image:
201+
202+
docker pull riptideio/pymodbus
203+
200204
Otherwise you can pull the trunk source and install from there::
201205

202206
git clone git://github.com/riptideio/pymodbus.git

pymodbus/repl/client/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,12 @@ Install pymodbus with repl support
1515
$ pip install pymodbus[repl] --upgrade
1616
```
1717

18+
## Docker
19+
Pull Docker image with everything installed
20+
21+
`docker pull riptideio/pymodbus`
22+
23+
1824
## Usage Instructions
1925
RTU and TCP are supported as of now
2026

@@ -32,7 +38,9 @@ Commands:
3238
serial
3339
tcp
3440
41+
# Or using a Docker run command instead
3542
43+
✗ docker run -it riptideio/pymodbus pymodbus.console --help
3644
```
3745
TCP Options
3846

pymodbus/repl/server/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,11 @@ Install `pymodbus` with the required dependencies
1919

2020
`pip install pymodbus[repl]`
2121

22+
## Docker
23+
Pull Docker image with everything installed
24+
25+
`docker pull riptideio/pymodbus`
26+
2227
## Usage
2328

2429
Invoke REPL server with `pymodbus.server run` command.
@@ -46,6 +51,12 @@ Invoke REPL server with `pymodbus.server run` command.
4651
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
4752
```
4853

54+
If using the docker image, you can run all the same commands, prepending the `docker run` command. For example:
55+
56+
```shell
57+
docker run -it riptideio/pymodbus pymodbus.server --help
58+
```
59+
4960
```shell
5061
✗ pymodbus.server run --help
5162

0 commit comments

Comments
 (0)