docs(rebranding): update readme
All checks were successful
All checks were successful
This commit is contained in:
40
README.md
40
README.md
@@ -1,40 +1,36 @@
|
||||
# Profanity
|
||||
 [](https://github.com/profanity-im/profanity/graphs/contributors/) [](https://repology.org/project/profanity/versions)
|
||||
# CProof
|
||||

|
||||
|
||||
Profanity is a console based XMPP client inspired by [Irssi](http://www.irssi.org/).
|
||||
CProof is a console based XMPP chat client based on [Profanity](https://profanity-im.github.io/).
|
||||
|
||||

|
||||

|
||||
|
||||
See the [User Guide](https://profanity-im.github.io/userguide.html) for information on installing and using Profanity.
|
||||
See the [Quick Start Guide](https://jabber.space/getting-started/quick-start/) for information on installing and using CProof.
|
||||
|
||||
## Project
|
||||
This project is about freedom, privacy and choice. We want to enable people to chat with one another in a safe way. Thus supporting encryption (OTR, PGP, OMEMO, OX) and being decentralized, meaning everyone can run their own server. We believe [XMPP](https://xmpp.org/) is a great proven protocol with an excellent community serving this purpose well.
|
||||
|
||||
CProof enables you to communicate with privacy, freedom and comfort. Our open-source chat application delivers secure, end-to-end encrypted messaging (OTR, PGP, OMEMO, OX) built on the trusted [XMPP](https://xmpp.org/) protocol. With a decentralized design, you can connect directly or even host your own server, keeping your data in your hands. Whether you're chatting with friends or collaborating securely, CProof makes private communication simple, reliable, and truly yours.
|
||||
|
||||
## Installation
|
||||
Our [user guide](https://profanity-im.github.io/userguide.html) contains an [install](https://profanity-im.github.io/guide/latest/install.html) section and a section for [building](https://profanity-im.github.io/guide/latest/build.html) from source yourself.
|
||||
Check our [installation guide](https://jabber.space/getting-started/installation/) for detailed instructions.
|
||||
|
||||
## How to contribute
|
||||
We tried to sum things up on our [helpout](https://profanity-im.github.io/helpout.html) page.
|
||||
Additionally you can check out our [blog](https://profanity-im.github.io/blog/) where we have articles like:
|
||||
[How to get a backtrace](https://profanity-im.github.io/blog/post/how-to-get-a-backtrace/) and [Contributing a Patch via GitHub](https://profanity-im.github.io/blog/post/contributing-a-patch-via-github/).
|
||||
For more technical details check out our [CONTRIBUTING.md](CONTRIBUTING.md) file.
|
||||
See our [Helping Out](https://jabber.space/contributing/helpout/) page for a concise summary of ways to help us.
|
||||
|
||||
Review the [Contributing Guide](CONTRIBUTING.md) and [Code Overview](https://jabber.space/contributing/code-overview/) pages for advanced technical details.
|
||||
|
||||
## Getting help
|
||||
To get help, first read our [User Guide](https://profanity-im.github.io/userguide.html) then check out the [FAQ](https://profanity-im.github.io/faq.html).
|
||||
If you are having a problem then first search the [issue tracker](https://github.com/profanity-im/profanity/issues).
|
||||
If you don't find anything there either come to our [MUC](xmpp:profanity@rooms.dismail.de?join) or create a new issue depending on what your problem is.
|
||||
Prior to asking questions, check our [User Guide](https://profanity-im.github.io/userguide.html), then check out the [FAQ](https://jabber.space/about/faq/).
|
||||
|
||||
If you are still having a problem then search the [issue tracker](https://git.jabber.space/devs/cproof/issues).
|
||||
|
||||
As a last resort, feel free to write us on [support@jabber.tech](mailto:support@jabber.tech) or create a new issue depending on what your problem is.
|
||||
|
||||
## Links
|
||||
|
||||
### Website
|
||||
<!-- TODO:
|
||||
URL: https://jabber.space/
|
||||
-->
|
||||
Feel free to visit our website: [jabber.space](https://jabber.space/).
|
||||
|
||||
Repo: https://git.jabber.space/devs/profanity
|
||||
|
||||
<!-- TODO: blog/docs link -->
|
||||
You may also check the repository if you like, available on [git.jabber.space/devs/profanity](https://git.jabber.space/devs/profanity).
|
||||
|
||||
### Plugins
|
||||
Plugins repository: https://github.com/profanity-im/profanity-plugins
|
||||
Plugins repository: https://git.jabber.space/devs/cproof-plugins
|
||||
|
||||
Reference in New Issue
Block a user