diff --git a/README.md b/README.md index 4f0d4b8b..7b0d403e 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,31 @@ # Greenlight -Greenlight is a simple front-end application for [BigBlueButton](http://bigbluebutton.org/). For an overview of how GreenLight works see +GreenLight is a simple (but powerful) front-end interface for your BigBlueButton server. At its core, GreenLight provides a minimalistic web-based application that lets users + + * Create a meeting + * Invite others to the meeting + * Join a meeting + +Furthermore, if you configure GreenLight to use either Google or Twitter for authentication (via OAuth2), users can login to record meetings and manage recordings. + +## Overview video + +For a overview of how GreenLight works, see the following video [![GreenLight Overview](https://img.youtube.com/vi/yGX3JCv7OVM/0.jpg)](https://youtu.be/yGX3JCv7OVM) -## Installation on BigBlueButton -We've created a Docker image to make it easy to install GreenLight on a BigBlueButton 1.1-beta (or later server). See [Installing GreenLight](http://docs.bigbluebutton.org/1.1/green-light.html) in the BigBlueButton documentation. -# Development +## Installation on the BigBlueButton server +We designed GreenLight to install on a [BigBlueButton 1.1-beta](http://docs.bigbluebutton.org/1.1/install.html) (or later) server. This means you don't need a separate server to run GreenLight. -GreenLight is a rails 5 application. +For more informaiton see [Installing GreenLight](http://docs.bigbluebutton.org/1.1/green-light.html). + +# Source Code + +GreenLight is a rails 5 application. + +Many developers already know Rails well, and we wanted to create both a full front-end to BigBlueButton but also a reference implementation of how to fully leverage the [BigBlueButton API](http://docs.bigbluebutton.org/dev/api.html). + +We invite you to build upon GreenLight and help make it better. See [Contributing to BigBlueButton](http://docs.bigbluebutton.org/support/faq.html#contributing-to-bigbluebutton). + +We invite your feedback, questions, and suggests about GreenLight too. Please post to the [developer mailing list](https://groups.google.com/forum/#!forum/bigbluebutton-dev).