Update README

This commit is contained in:
JC Brand 2021-12-01 11:51:33 +01:00
parent 4c6ce2e905
commit cc3dae61ad
1 changed files with 38 additions and 34 deletions

View File

@ -1,24 +1,24 @@
<h2 align="center">
<a href="https://conversejs.org" target="_blank" rel="noopener">
<img alt="Converse-Desktop" src="https://github.com/conversejs/converse.js/blob/master/logo/readme.png" width="480">
</a>
</h2>
# Converse Desktop # Converse Desktop
This project started as a fork of Nick Denry's [Chimeverse](https://github.com/conversejs/converse-desktop). ## Jabber/XMPP client based on Converse.js and Electron
#### Jabber/XMPP client based on Converse.js and Electron [![XMPP Chat](https://conference.conversejs.org/muc_badge/discuss@conference.conversejs.org)](https://inverse.chat/#converse/room?jid=discuss@conference.conversejs.org)
![Version](https://img.shields.io/npm/v/chimeverse/latest.svg) A basic integration of [Converse.js](https://conversejs.org/) and Electron. With OMEMO.
![Downloads](https://img.shields.io/npm/dt/chimeverse.svg)
<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=6MZ5YRYEDSVSQ&source=url" title="Donate once-off to this project using Paypal">
<img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPayl donate button" />
</a>
It should happen once. A very basic integration of [Converse.js](https://conversejs.org/) and Electron. With OMEMO. ## Screenshots and feautures
#### Screenshots and feautures
<p float="left"> <p float="left">
<img width="403" alt="Account form" src="https://user-images.githubusercontent.com/1450983/89672948-33bc0e80-d8ee-11ea-983f-21bbb707b45d.png"> <img width="403" alt="Account form" src="https://user-images.githubusercontent.com/1450983/89672948-33bc0e80-d8ee-11ea-983f-21bbb707b45d.png">
<img width="403" alt="Main window" src="https://user-images.githubusercontent.com/1450983/89673019-4f271980-d8ee-11ea-8058-0ac6269983aa.png"> <img width="403" alt="Main window" src="https://user-images.githubusercontent.com/1450983/89673019-4f271980-d8ee-11ea-8058-0ac6269983aa.png">
<img width="403" alt="Chat" src="https://user-images.githubusercontent.com/1450983/89673064-68c86100-d8ee-11ea-86c4-137e1b95dae7.png"> <img width="403" alt="Chat" src="https://user-images.githubusercontent.com/1450983/89673064-68c86100-d8ee-11ea-86c4-137e1b95dae7.png">
<img width="403" alt="Settings screen" src="https://user-images.githubusercontent.com/1450983/89673104-7847aa00-d8ee-11ea-8d30-8f84e7709e7c.png"> <img width="403" alt="Settings screen" src="https://user-images.githubusercontent.com/1450983/89673104-7847aa00-d8ee-11ea-8d30-8f84e7709e7c.png">
</p> </p>
- Permanent account storage - Permanent account storage
@ -27,17 +27,7 @@ It should happen once. A very basic integration of [Converse.js](https://convers
- All the best from Converse.js like system notifications, MAM, OMEMO etc. See details at [Converse.js](https://conversejs.org/) - All the best from Converse.js like system notifications, MAM, OMEMO etc. See details at [Converse.js](https://conversejs.org/)
#### License information ## Changelog
Like Converse.js, Converse Desktop's files are released under the Mozilla Public License version 2 (MPLv2). The gist of this license is that the covered files must stay open source, and modifications to them need to be released under the same license, but new files (for example for your own plugin) don't have to be released under the same license.
However, libsignal library, which is required for OMEMO support is released under the GPLv3. The MPLv2 license is compatible with GPLv3 and when GPLv3 code is included, the entire project effectively is licensed under the GPLv3.
Any custom build of Converse Desktop without libsignal included will again be licensed
under the MPLv2.
#### Changelog
See [CHANGES.md](https://github.com/conversejs/converse-desktop/blob/master/CHANGES.md) See [CHANGES.md](https://github.com/conversejs/converse-desktop/blob/master/CHANGES.md)
@ -53,27 +43,22 @@ See [CHANGES.md](https://github.com/conversejs/converse-desktop/blob/master/CHAN
- [All releases](https://github.com/conversejs/converse-desktop/releases) - [All releases](https://github.com/conversejs/converse-desktop/releases)
#### Run with npm ## Build from source
``` ```bash
git clone https://github.com/conversejs/converse-desktop.git git clone https://github.com/conversejs/converse-desktop.git
cd converse-desktop cd converse-desktop
npm i npm i
$(npm bin)/electron-rebuild $(npm bin)/electron-rebuild
```
Then, to run:
```bash
npm start npm start
``` ```
### Development ### Build targets:
Prepare
```
git clone https://github.com/conversejs/converse-desktop.git
cd converse-desktop
npm i
$(npm bin)/electron-rebuild
```
Build targets
| Operation System | Target | | Operation System | Target |
-------------------|---------------- -------------------|----------------
@ -82,3 +67,22 @@ Build targets
| Linux DEB | `npm run dist:linux64deb` | | Linux DEB | `npm run dist:linux64deb` |
More targets could be added via `package.json`. See [electron builder docs](https://www.electron.build/configuration/configuration). More targets could be added via `package.json`. See [electron builder docs](https://www.electron.build/configuration/configuration).
## License
Like Converse.js, Converse Desktop's files are released under the Mozilla Public License version 2 (MPLv2). The gist of this license is that the covered files must stay open source, and modifications to them need to be released under the same license, but new files (for example for your own plugin) don't have to be released under the same license.
However, libsignal library, which is required for OMEMO support is released under the GPLv3. The MPLv2 license is compatible with GPLv3 and when GPLv3 code is included, the entire project effectively is licensed under the GPLv3.
Any custom build of Converse Desktop without libsignal included will again be licensed
under the MPLv2.
## Acknowledgements
This project started as a fork of Nick Denry's [Chimeverse](https://github.com/conversejs/converse-desktop).
<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=6MZ5YRYEDSVSQ&source=url" title="Donate once-off to this project using Paypal">
<img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPayl donate button" />
</a>