decentral1se
/
cairde
Archived
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

docs: some wording

This commit is contained in:
decentral1se 2023-07-23 18:47:09 +02:00
parent 337f5ae6b9
commit 0d6b059011
Signed by: decentral1se
GPG Key ID: 03789458B3D0C410
2 changed files with 12 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
LICENSE
View File

@ -1,4 +1,4 @@
cairde: A text-based user interface for metadata resistant online chat.
cairde: a terminal client for metadata resistant messaging built on the Cwtch protocol.
Copyright (C) 2023 decentral1se
This program is free software: you can redistribute it and/or modify

32
README.md
View File

@ -2,33 +2,25 @@
> Cairde /ˈkɑːɾˠdʲə/, an Irish word which translates as "friends"
A text-based user interface which uses the [Cwtch
protocol](https://docs.openprivacy.ca/cwtch-security-handbook/overview.html#what-is-cwtch)
for metadata resistant online chat.
A terminal client for metadata resistant messaging built on the [Cwtch
protocol](https://docs.openprivacy.ca/cwtch-security-handbook/overview.html#what-is-cwtch).
This is a **pre-alpha prototype** and an *unofficial* community implementation
which is currently only ready for experimentation and testing. Please *do not*
use existing `cwtch-ui` profiles with `cairde`! We cannot guarantee that things
will not break at this early stage.
use existing [`cwtch-ui`](https://cwtch.im/download/) profiles with `cairde`!
We cannot guarantee that things will not break at this early stage.
Please see [cwtch.im](https://cwtch.im/download/) for the official Cwtch GUI.
If you're new to Cwtch, this
[video](https://docs.openprivacy.ca/cwtch-security-handbook/overview.html#a-video-explainer)
or [the docs](https://docs.cwtch.im/) are a great place to start.
## Feature set
## Features
> Coming Soon ™
## Prerequisites
## Install
### Tor
On Debian systems, you can install with:
```
sudo apt install tor
```
> Coming Soon ™
## Hack
@ -39,13 +31,11 @@ go build -v .
## Contribute
It would be wonderful if you'd like to help out: code, design, thoughts,
testing, documentation or otherwise! Feel free to reach out to me on Cwtch:
`52u75tikfpxm7xgjcbuxmtmtojkh3wb32balgu7bem7aix3qrwubo7qd`. We're also lurking
on the [Release candidate testers
group](https://docs.cwtch.im/docs/contribute/testing#join-the-cwtch-release-candidate-testers-group).
It would be wonderful if you'd like to help out: feedback, design, testing,
documentation, code or otherwise! You can find my contact details
[here](https://vvvvvvaria.org/~decentral1se/).
## References
## Acknowledgements
* [`charmbracelet/bubbletea`](https://github.com/charmbracelet/bubbletea)
* [`cwtch.im/cwtch`](https://git.openprivacy.ca/cwtch.im/cwtch)