aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSaúl Ibarra Corretgé <s@saghul.net>2018-08-13 09:18:18 +0200
committerSaúl Ibarra Corretgé <s@saghul.net>2018-08-14 09:37:08 +0200
commit1d07edd252f5b4eab500b4b481f1f6736187b840 (patch)
treeaabe5f2c7f5a910500328a7319c44c2fb44b67b2 /README.md
parent36c2978782982d39ed01f8cee8bc752321fc2af6 (diff)
Update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 12 insertions, 2 deletions
diff --git a/README.md b/README.md
index 1387852..37ba029 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,8 @@
Desktop application for [Jitsi Meet] built with [Electron].
+![](screenshot.png)
+
## Features
- Works with any Jitsi Meet deployment
@@ -15,7 +17,9 @@ Desktop application for [Jitsi Meet] built with [Electron].
Grab the [latest release] and you're off to the races! The supported platforms
are macOS, Windows (both 32 and 64bits) and GNU/Linux (64bits only).
-NOTE: On old GNU/Linux distributions you might get the following error:
+<details><summary>NOTE for old GNU/Linux distributions</summary>
+
+You might get the following error:
```
FATAL:nss_util.cc(632)] NSS_VersionCheck("3.26") failed. NSS >= 3.26 is required.
@@ -29,11 +33,15 @@ If you do, please install NSS (example for Debian / Ubuntu):
sudo apt-get install libnss3
```
+</details>
+
## Development
If you want to hack on this project, here is how you do it.
-#### Building the sources
+<details><summary>Expand</summary>
+
+#### Installing dependencies
```bash
npm install
@@ -81,6 +89,8 @@ npm install jitsi-meet-electron-utils --force
NOTE: Also check the [jitsi-meet-electron-utils README] to see how to configure
your environment.
+</details>
+
## License
Apache 2. See the [LICENSE] file.