converse-desktop/README.md

# 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

![Version](https://img.shields.io/npm/v/chimeverse/latest.svg)
![Downloads](https://img.shields.io/npm/dt/chimeverse.svg)
![License](https://img.shields.io/npm/l/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
<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="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="Settings screen" src="https://user-images.githubusercontent.com/1450983/89673104-7847aa00-d8ee-11ea-8d30-8f84e7709e7c.png">

</p>

- Permanent account storage
- Tray icon
- Tray notifications
- All the best from Converse.js like system notifications, MAM, OMEMO etc. See details at [Converse.js](https://conversejs.org/)

#### Changelog

See [CHANGES.md](https://github.com/conversejs/converse-desktop/blob/master/CHANGES.md)

#### Run with npm

```
git clone https://github.com/conversejs/converse-desktop.git
cd converse-desktop
npm i
$(npm bin)/electron-rebuild
npm start
```

### Development

Prepare
```
git clone https://github.com/conversejs/converse-desktop.git
cd converse-desktop
npm i
$(npm bin)/electron-rebuild
```

Build targets

| Operation System | Target |
-------------------|----------------
| macOS            | `npm run dist` |
| Windows          | `npm run dist:win64` |
| Linux DEB        | `npm run dist:linux64deb` |

More targets could be added via `package.json`. See [electron builder docs](https://www.electron.build/configuration/configuration).
Fix path at howto run 2020-08-07 11:57:21 +00:00			`# Converse Desktop`
Start renaming Chimeverse to Converse Desktop 2020-07-22 14:33:06 +00:00
			`This project started as a fork of Nick Denry's [Chimeverse](https://github.com/conversejs/converse-desktop).`
Initial commit Start from electron-quick-start 2019-04-22 23:10:11 +00:00
Update README 2019-04-26 02:09:17 +00:00			`#### Jabber/XMPP client based on Converse.js and Electron`
Initial commit Start from electron-quick-start 2019-04-22 23:10:11 +00:00
Add badges 2019-05-02 00:20:29 +00:00			`![Version](https://img.shields.io/npm/v/chimeverse/latest.svg)`
			`![Downloads](https://img.shields.io/npm/dt/chimeverse.svg)`
			`![License](https://img.shields.io/npm/l/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>`

Add settings screen 2020-05-13 15:36:44 +00:00			`It should happen once. A very basic integration of [Converse.js](https://conversejs.org/) and Electron. With OMEMO.`
Initial commit Start from electron-quick-start 2019-04-22 23:10:11 +00:00
Add feautures 2019-04-26 02:27:00 +00:00			`#### Screenshots and feautures`
Add screenshots 2019-04-26 02:24:42 +00:00			`<p float="left">`
Update screenshots 2020-08-07 17:42:52 +00:00			`<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="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">`
Add settings screen 2020-05-13 15:36:44 +00:00
Add screenshots 2019-04-26 02:24:42 +00:00			`</p>`
Initial commit Start from electron-quick-start 2019-04-22 23:10:11 +00:00
Add feautures 2019-04-26 02:27:00 +00:00			`- Permanent account storage`
			`- Tray icon`
			`- Tray notifications`
Fix typo 2019-04-26 22:10:00 +00:00			`- All the best from Converse.js like system notifications, MAM, OMEMO etc. See details at [Converse.js](https://conversejs.org/)`
Add feautures 2019-04-26 02:27:00 +00:00
Update release information 2019-04-26 21:52:57 +00:00			`#### Changelog`

Start renaming Chimeverse to Converse Desktop 2020-07-22 14:33:06 +00:00			`See [CHANGES.md](https://github.com/conversejs/converse-desktop/blob/master/CHANGES.md)`
Initial commit Start from electron-quick-start 2019-04-22 23:10:11 +00:00
Add "run with npm" section 2019-04-27 00:48:58 +00:00			`#### Run with npm`

			```
Start renaming Chimeverse to Converse Desktop 2020-07-22 14:33:06 +00:00			`git clone https://github.com/conversejs/converse-desktop.git`
Fix path at howto run 2020-08-07 11:57:21 +00:00			`cd converse-desktop`
Add "run with npm" section 2019-04-27 00:48:58 +00:00			`npm i`
			`$(npm bin)/electron-rebuild`
			`npm start`
			```
Add build how-to info 2020-05-28 14:50:43 +00:00
			`### Development`

Fix typo 2020-06-02 14:55:26 +00:00			`Prepare`
Add build how-to info 2020-05-28 14:50:43 +00:00			```
Start renaming Chimeverse to Converse Desktop 2020-07-22 14:33:06 +00:00			`git clone https://github.com/conversejs/converse-desktop.git`
Fix path at howto run 2020-08-07 11:57:21 +00:00			`cd converse-desktop`
Add build how-to info 2020-05-28 14:50:43 +00:00			`npm i`
			`$(npm bin)/electron-rebuild`
			```

			`Build targets`

Fix typo 2020-06-02 13:31:17 +00:00			`\| Operation System \| Target \|`
Add build how-to info 2020-05-28 14:50:43 +00:00			`-------------------\|----------------`
			\| macOS \| `npm run dist` \|
			\| Windows \| `npm run dist:win64` \|
			\| Linux DEB \| `npm run dist:linux64deb` \|

Update installers 2020-05-28 16:35:38 +00:00			More targets could be added via `package.json`. See [electron builder docs](https://www.electron.build/configuration/configuration).