6
1
mirror of https://git.mills.io/saltyim/saltyim.git synced 2024-06-20 13:58:22 +00:00
prologic-saltyim/README.md

30 lines
734 B
Markdown
Raw Normal View History

2022-03-19 05:43:43 +00:00
# Salty IM
2022-03-26 00:48:01 +00:00
[![Build Status](https://ci.mills.io/api/badges/saltyim/saltyim/status.svg)](https://ci.mills.io/saltyim/saltyim)
2022-03-19 05:43:43 +00:00
## Quick Start
```#!sh
2022-03-19 13:05:36 +00:00
$ go install go.mills.io/saltyim/cmd/salty-chat@latest
$ salty-chat make-user user@domain
2022-03-19 05:48:42 +00:00
$ salty-chat chat prologic@mills.io
2022-03-19 05:43:43 +00:00
```
2022-03-23 00:16:52 +00:00
## Documentation
2022-03-19 05:43:43 +00:00
2022-03-23 00:16:52 +00:00
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).
2022-03-19 05:43:43 +00:00
### Deploy With Docker Swarm and Cloudflare
Visit: [deployment](./deployment/)
2022-03-23 00:16:52 +00:00
## Roadmap
2022-03-16 12:45:16 +00:00
2022-03-23 00:16:52 +00:00
Please refer to the [Roadmap](./Roadmap.md) document.
2022-03-16 12:45:16 +00:00
## License
`salty-msgbus-chat` is licensed under the terms of the [WTFPL](/LICENSE) license.