Fix README (Fixes #74)

pull/175/head
James Mills 2 months ago
parent 5253269b19
commit 2d6abaf918
Signed by: prologic
GPG Key ID: AC4C014F1440EBD6
  1. 4
      LICENSE
  2. 1
      Makefile
  3. 36
      README.md
  4. 2
      docs/Development.md
  5. BIN
      docs/logo.pong

@ -1,6 +1,6 @@
Copyright (C) 2017 James Mills
Copyright (C) 2022-present James Mills
salty-chat is covered by the MIT license::
salty-chat and saltyd are covered by the MIT license::
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation

@ -6,7 +6,6 @@ VERSION=$(shell git describe --abbrev=0 --tags 2>/dev/null || echo "0.0.0")
COMMIT=$(shell git rev-parse --short HEAD || echo "HEAD")
BRANCH=$(shell git rev-parse --abbrev-ref HEAD)
GOCMD=go
GOVER=$(shell go version | grep -o -E 'go1\.17\.[0-9]+')
DESTDIR=/usr/local/bin

@ -1,10 +1,33 @@
# Salty IM
# Salty IM -- secure, easy, self-hosted messaging
[![Build Status](https://ci.mills.io/api/badges/saltyim/saltyim/status.svg)](https://ci.mills.io/saltyim/saltyim)
[![Go Report Card](https://goreportcard.com/badge/git.mills.io/saltyim/saltyim)](https://goreportcard.com/report/git.mills.io/saltyim/saltyim)
[![Go Reference](https://pkg.go.dev/badge/go.mills.io/saltyim.svg)](https://pkg.go.dev/go.mills.io/saltyim)
## Quick Start CLI)
![](./docs/logo.png)
```#!sh
[Salty IM](https://salty.im) is a secure, decentrlaised and easy self-hosted
instant messaging alternative. Salty IM is fully encrypted using the
[salty](https://git.mills.io/prologic/salty) Go library utilising the
[Saltypack](https://saltpack.org/) messaging format and parts of
[keys.pub](https://keys.pub/) implemtnation for its cryptography.
Encryption, Decryption and Signing of messages is performed with public key
cryptography using the Ed25519 algoritms.
For more information on how the protocol works, please refer to the
[Specification](https://salty.im/spec.html).
This repository also contains a reference client (written in Go), a reference
broker (server) as well as a Terminal TUI (TUI) client called `salty-chat` and
command-line tools:
- `saltyd` -- Reference broker (server)
- `salty-chat` -- Command-line tools and Terminal UI (TUI)
- [saltyim](https://pkg.go.dev/go.mills.io/saltyim) -- Reference client (Go library)
## Quick Start CLI
```console
$ go install go.mills.io/saltyim/cmd/salty-chat@latest
$ salty-chat make-user user@domain
# Follow the insturctions
@ -16,10 +39,9 @@ broker and your domain name.
## Quick Start (DEV)
## Documentation
> See also the [Old Readme](./OLDREADME.md) for how this
> 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).
@ -32,5 +54,5 @@ Please refer to the [Roadmap](./Roadmap.md) document.
## License
`saltyd` and `salty-chat` are licensed under the terms of the
[WTFPL](/LICENSE) license.
`saltyd` and `salty-chat` are licensed under the terms of the [MIT](/LICENSE)
license.

@ -91,4 +91,4 @@ For example chatting with `bar@home.arpa` from `foo@home.arpa`:
And the other way around:
![](./screenshots/screenshot-chat-bar.png)
![](./screenshots/screenshot-chat-bar.png)

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.8 KiB

Loading…
Cancel
Save