Browse Source

feat(doc) revamp README

master
Saúl Ibarra Corretgé 3 years ago
parent
commit
d21eb59f24
2 changed files with 55 additions and 49 deletions
  1. 55
    49
      README.md
  2. BIN
      readme-img1.png

+ 55
- 49
README.md View File

@@ -1,82 +1,88 @@
1
-# Jitsi Meet - Secure, Simple and Scalable Video Conferences
1
+# <p align="center">Jitsi Meet</p>
2 2
 
3
-Jitsi Meet is an open-source (Apache) WebRTC JavaScript application that uses [Jitsi Videobridge](https://jitsi.org/videobridge) to provide high quality, [secure](https://jitsi.org/security) and scalable video conferences. Jitsi Meet in action can be seen at [here at the session #482 of the VoIP Users Conference](http://youtu.be/7vFUVClsNh0).
3
+Jitsi Meet is a set of Open Source projects which empower users to use and deploy
4
+video conferencing platforms with state-of-the-art video quality and features.
4 5
 
5
-The Jitsi Meet client runs in your browser, without installing anything on your computer. You can try it out at https://meet.jit.si.
6
+<hr />
6 7
 
7
-Jitsi Meet allows for very efficient collaboration. Users can stream their desktop or only some windows. It also supports shared document editing with Etherpad.
8
+<p align="center">
9
+<img src="https://raw.githubusercontent.com/jitsi/jitsi-meet/master/readme-img1.png" width="900" />
10
+</p>
8 11
 
9
-**NOTE:** If you are looking for Jitsi as a Service (JaaS) please start [here](https://jaas.8x8.vc).
12
+<hr />
10 13
 
11
-## Installation
14
+Amongst others here are the main features Jitsi Meet offers:
12 15
 
13
-On the client side, no installation is necessary. You just point your browser to the URL of your deployment. This section is about installing a Jitsi Meet suite on your server and hosting your own conferencing service.
16
+* Support for all current browsers
17
+* Mobile applications
18
+* Web and native SDKs for integration
19
+* HD audio and video
20
+* Content sharing
21
+* End-to-End Encryption
22
+* Raise hand and reactions
23
+* Chat with private conversations
24
+* Polls
25
+* Virtual backgrounds
14 26
 
15
-Installing Jitsi Meet is a simple experience. For Debian-based system, following the [quick install](https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-quickstart) document, which uses the package system. You can also see a demonstration of the process in [this tutorial video](https://jitsi.org/tutorial).
27
+And many more!
16 28
 
17
-For other systems, or if you wish to install all components manually, see the [detailed manual installation instructions](https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-manual).
29
+## Using Jitsi Meet
18 30
 
19
-Installation with Docker is also available. Please see the [instruction](https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-docker).
31
+Using Jitsi Meet is straightforward, as it's browser based. Head over to [meet.jit.si](https://meet.jit.si) and give it a try. It's anonymous, scalable and free to use. All browsers are supported! 
20 32
 
21
-## Download
33
+Using mobile? No problem, you can either use your mobile web browser or our fully-featured
34
+mobile apps:
22 35
 
23
-| Latest stable release | [![release](https://img.shields.io/badge/release-latest-green.svg)](https://github.com/jitsi/jitsi-meet/releases/latest) |
24
-|---|---|
36
+| Android | Android (F-Droid) | iOS |
37
+|:-:|:-:|:-:|
38
+| [<img src="resources/img/google-play-badge.png" height="50">](https://play.google.com/store/apps/details?id=org.jitsi.meet) | [<img src="resources/img/f-droid-badge.png" height="50">](https://f-droid.org/en/packages/org.jitsi.meet/) | [<img src="resources/img/appstore-badge.png" height="50">](https://itunes.apple.com/us/app/jitsi-meet/id1165103905) |
25 39
 
26
-You can download Debian/Ubuntu binaries:
27
-* [stable](https://download.jitsi.org/stable/) ([instructions](https://jitsi.org/downloads/ubuntu-debian-installations-instructions/))
28
-* [testing](https://download.jitsi.org/testing/) ([instructions](https://jitsi.org/downloads/ubuntu-debian-installations-instructions-for-testing/))
29
-* [nightly](https://download.jitsi.org/unstable/) ([instructions](https://jitsi.org/downloads/ubuntu-debian-installations-instructions-nightly/))
40
+If you are feeling adventurous and want to get an early scoop of the features as they are being
41
+developed you can also sign up for our open beta testing here:
30 42
 
31
-You can download source archives (produced by ```make source-package```):
32
-* [source builds](https://download.jitsi.org/jitsi-meet/src/)
43
+* [Android](https://play.google.com/apps/testing/org.jitsi.meet)
44
+* [iOS](https://testflight.apple.com/join/isy6ja7S)
33 45
 
34
-### Mobile apps
46
+## Running your own instance
35 47
 
36
-* [Android](https://play.google.com/store/apps/details?id=org.jitsi.meet)
48
+If you'd like to run your own Jitsi Meet installation head over to the [handbook](https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-start) to get started.
37 49
 
38
-[<img src="resources/img/google-play-badge.png" height="50">](https://play.google.com/store/apps/details?id=org.jitsi.meet)
50
+We provide Debian packages and a comprehensive Docker setup to make deployments as simple as possible.
51
+Advanced users also have the possibility of building all the components from source.
39 52
 
40
-* [Android (F-Droid)](https://f-droid.org/en/packages/org.jitsi.meet/)
53
+You can check the latest releases [[here](https://jitsi.github.io/handbook/docs/releases).
41 54
 
42
-[<img src="resources/img/f-droid-badge.png" height="50">](https://f-droid.org/en/packages/org.jitsi.meet/)
55
+## Jitsi as a Service
43 56
 
44
-* [iOS](https://itunes.apple.com/us/app/jitsi-meet/id1165103905)
57
+If you like the branding capabilities of running your own instance but you'd like
58
+to avoid dealing with the complexity of monitoring, scaling and updates, JaaS might be
59
+for you.
45 60
 
46
-[<img src="resources/img/appstore-badge.png" height="50">](https://itunes.apple.com/us/app/jitsi-meet/id1165103905)
61
+[8x8 Jitsi as a Service (JaaS)](https://jaas.8x8.vc) is an enterprise-ready video meeting platform that allows developers, organizations and businesses to easily build and deploy video solutions. With Jitsi as a Service we now give you all the power of Jitsi running on our global platform so you can focus on building secure and branded video experiences.
47 62
 
48
-You can also sign up for our open beta testing here:
63
+## Documentation
49 64
 
50
-* [Android](https://play.google.com/apps/testing/org.jitsi.meet)
51
-* [iOS](https://testflight.apple.com/join/isy6ja7S)
65
+All the Jitsi Meet documentation is available in [the handbook](https://jitsi.github.io/handbook/).
52 66
 
53
-## Release notes
67
+## Security
54 68
 
55
-Release notes for Jitsi Meet are maintained on [this repository](https://github.com/jitsi/jitsi-meet-release-notes).
69
+For a comprehensive description of all Jitsi Meet's security aspects, please check [this link](https://jitsi.org/security).
56 70
 
57
-## Development
71
+For a detailed description of Jitsi Meet's End-to-End Encryption (E2EE) implementation,
72
+please check [this link](https://jitsi.org/e2ee-whitepaper/).
58 73
 
59
-For web development see [here](https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-web), and for mobile see [here](https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-mobile).
74
+For information on reporting security vulnerabilities in Jitsi Meet, see [SECURITY.md](./SECURITY.md).
60 75
 
61 76
 ## Contributing
62 77
 
63 78
 If you are looking to contribute to Jitsi Meet, first of all, thank you! Please
64 79
 see our [guidelines for contributing](CONTRIBUTING.md).
65 80
 
66
-## Embedding in external applications
67
-
68
-Jitsi Meet provides a very flexible way of embedding in external applications by using the [Jitsi Meet API](doc/api.md).
69
-
70
-## Security
71
-
72
-The security section here was starting to feel a bit too succinct for the complexity of the topic, so we created a post that covers the topic much more broadly here: https://jitsi.org/security
73
-
74
-The section on end-to-end encryption in that document is likely going to be one of the key points of interest: https://jitsi.org/security/#e2ee
75
-
76
-## Security issues
77
-
78
-For information on reporting security vulnerabilities in Jitsi Meet, see [SECURITY.md](./SECURITY.md).
79
-
80
-## Acknowledgements
81
+<br />
82
+<br />
81 83
 
82
-Jitsi Meet started out as a sample conferencing application using Jitsi Videobridge. It was originally developed by ESTOS' developer Philipp Hancke who then contributed it to the community where development continues with joint forces!
84
+<footer>
85
+<p align="center" style="font-size: smaller;">
86
+Built with ❤️ by the Jitsi team at <a href="https://8x8.com" target="_blank">8x8</a> and our community.
87
+</p>
88
+</footer>

BIN
readme-img1.png View File


Loading…
Cancel
Save