6
1
mirror of https://git.mills.io/saltyim/saltyim.git synced 2024-06-16 11:58:24 +00:00
prologic-saltyim/README.md
m u t e f a l l 12fc010ce7 docker swarm deployment and dns documentation (#167)
this changeset addresses the need for a simple docker swarm deployment and setup of dns records on cloudflare.

Co-authored-by: m u t e f a l l <mutefall@noreply.mills.io>
Reviewed-on: https://git.mills.io/saltyim/saltyim/pulls/167
Reviewed-by: James Mills <james@mills.io>
Co-authored-by: m u t e f a l l <mutefall@noreply@mills.io>
Co-committed-by: m u t e f a l l <mutefall@noreply@mills.io>
2022-04-26 01:44:51 +00:00

30 lines
734 B
Markdown

# Salty IM
[![Build Status](https://ci.mills.io/api/badges/saltyim/saltyim/status.svg)](https://ci.mills.io/saltyim/saltyim)
## Quick Start
```#!sh
$ go install go.mills.io/saltyim/cmd/salty-chat@latest
$ salty-chat make-user user@domain
$ salty-chat chat prologic@mills.io
```
## Documentation
Coming soon™ -- See also the [Old Readme](./OLDREADME.md) for how this
implementation started out as a simple shell script which you can still
find at [salty-chat.sh](./bin/salty-chat.sh).
### Deploy With Docker Swarm and Cloudflare
Visit: [deployment](./deployment/)
## Roadmap
Please refer to the [Roadmap](./Roadmap.md) document.
## License
`salty-msgbus-chat` is licensed under the terms of the [WTFPL](/LICENSE) license.