From c91083c77012033d4369b0c9d5d04b4af7276db5 Mon Sep 17 00:00:00 2001 From: Nick Denry Date: Fri, 26 Apr 2019 05:09:17 +0300 Subject: [PATCH] Update README --- README.md | 49 +++++++++---------------------------------------- 1 file changed, 9 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index df7ef6d..1a779c1 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,14 @@ -# electron-quick-start +# Chimeverse -**Clone and run for a quick way to see Electron in action.** +#### Jabber/XMPP client based on Converse.js and Electron -This is a minimal Electron application based on the [Quick Start Guide](https://electronjs.org/docs/tutorial/quick-start) within the Electron documentation. +It should happen once. +A very basic integration of [Converse.js](https://conversejs.org/) and Electron. With OMEMO. -**Use this app along with the [Electron API Demos](https://electronjs.org/#get-started) app for API code examples to help you get started.** +#### Screenshots etc. +TBD -A basic Electron application needs just these files: +#### Current release + - [Chimeverse-0.0.14.dmg](https://github.com/nick-denry/Chimeverse/releases/download/0.0.14/Chimeverse-0.0.14.dmg) + - [Chimeverse-0.0.14.dmg.zip](https://github.com/nick-denry/Chimeverse/releases/download/0.0.14/Chimeverse-0.0.14.dmg.zip) -- `package.json` - Points to the app's main file and lists its details and dependencies. -- `main.js` - Starts the app and creates a browser window to render HTML. This is the app's **main process**. -- `index.html` - A web page to render. This is the app's **renderer process**. - -You can learn more about each of these components within the [Quick Start Guide](https://electronjs.org/docs/tutorial/quick-start). - -## To Use - -To clone and run this repository you'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) installed on your computer. From your command line: - -```bash -# Clone this repository -git clone https://github.com/electron/electron-quick-start -# Go into the repository -cd electron-quick-start -# Install dependencies -npm install -# Run the app -npm start -``` - -Note: If you're using Linux Bash for Windows, [see this guide](https://www.howtogeek.com/261575/how-to-run-graphical-linux-desktop-applications-from-windows-10s-bash-shell/) or use `node` from the command prompt. - -## Resources for Learning Electron - -- [electronjs.org/docs](https://electronjs.org/docs) - all of Electron's documentation -- [electronjs.org/community#boilerplates](https://electronjs.org/community#boilerplates) - sample starter apps created by the community -- [electron/electron-quick-start](https://github.com/electron/electron-quick-start) - a very basic starter Electron app -- [electron/simple-samples](https://github.com/electron/simple-samples) - small applications with ideas for taking them further -- [electron/electron-api-demos](https://github.com/electron/electron-api-demos) - an Electron app that teaches you how to use Electron -- [hokein/electron-sample-apps](https://github.com/hokein/electron-sample-apps) - small demo apps for the various Electron APIs - -## License - -[CC0 1.0 (Public Domain)](LICENSE.md)