nicolabs/nicobot
1
0
Fork 0
mirror of https://github.com/nicolabs/nicobot.git synced 2026-05-20 09:44:26 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

minor doc fixes

Browse source
This commit is contained in:
nicobo 2021-03-08 22:06:36 +01:00
parent d99ccc446a
commit 891ec29daf
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -90,17 +90,17 @@ Now you can run the bots by their name as if they were installed via the package
At the present time there are [several Docker images available](https://hub.docker.com/r/nicolabs/nicobot/tags), with the following tags :
- **debian** (or **X.Y.Z-debian**) : this is the most portable image ; in order to keep it relatively small it does not include the *Signal* backend (will throw an error if you try --> use XMPP instead)
- **debian** (or **X.Y.Z-debian**) : this is the most portable image ; it should offer the best platforms compatibility. However, in order to keep it relatively small, it does not include the *Signal* backend (will throw an error if you try --> use XMPP instead)
- **signal-debian** (or **X.Y.Z-signal-debian**) : this is the most complete image ; it is also the largest one, but allows *Signal* messaging
- **signal-debian** (or **X.Y.Z-signal-debian**) : this is the most complete image ; it is also the largest one, but allows both XMPP and *Signal* messaging systems
- **alpine** (or **X.Y.Z-alpine**) : this should be the smallest image, but it's more complex to maintain and therefore might not always meet this expectation. Also, due to the lack/complexity of Alpine support for some Python, Java & native dependencies, images may support less platforms and it currently doesn't provide the Signal backend (you can use XMPP instead).
- **alpine** (or **X.Y.Z-alpine**) : this should be the smallest image, but it's more complex to maintain and therefore might not always meet the expectations. Also, due to the lack/complexity of Alpine support for some Python, Java & native dependencies, images may support less platforms and it currently doesn't embed the Signal backend (you can use XMPP instead).
- **X.Y.Z-\<image variant\>** tags are simply version *X.Y.Z* of *\<image variant\>*. E.g. *1.2.3-alpine* is nicobot version 1.2.3 in the *alpine* variant (not related with alpine's version).
- **latest** points to the latest versioned image of *signal-debian* (which offers all features).
- **dev-\<image variant\>** tags are development versions of the master branch. **Do not use : they are probably broken !** History is currently not preserved : there is only one *dev-* tag of an image variant at a time.
- **dev-\<image variant\>** tags are development versions of the *master branch*. **Do not use : they are probably broken !** History is currently not preserved : there is only one *dev-* tag of an image variant at a time.
Please have a look at the status shields at the top of this document to get more details like status and size.