Merge pull request #122 from liquidvotingio/add-video-to-readme

Add video demo to README

README.md

@@ -2,18 +2,18 @@
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop-hq/rubocop)
 [![YourActionName Actions Status](https://github.com/liquidvotingio/decidim-module-liquidvoting/workflows/CI/badge.svg)](https://github.com/liquidvotingio/decidim-module-liquidvoting/actions)
 
-Integrates Decidim with the [liquidvoting.io API](https://www.liquidvoting.io/).
+Integrates Decidim with the [liquidvoting.io API](https://www.liquidvoting.io/api).
 
-**WIP - not ready for production**
+**Note: In alpha**. Not yet used in production. But it's ready for a pilot!
 
-## Usage
+https://user-images.githubusercontent.com/21290/120000386-a952b180-bfca-11eb-9e94-82b875048b6b.mp4
+
+The integration enables delegations of supports for proposals in participatory processes and assemblies, and redirects supports so they go through the API, in order to calculate results based on different voting weights of delegates.
 
-Liquidvoting will be available as a Component for a Participatory
-Space.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to the Decidim instance's Gemfile:
 
 ```ruby
 gem "decidim-liquidvoting", git: "https://github.com/liquidvotingio/decidim-module-liquidvoting"
@@ -25,7 +25,13 @@ And then execute:
 bundle
 ```
 
-## Running locally, with local API instance
+By default the instance will connect with the live api hosted on https://api.liquidvoting.io/, and use a demo organization there.
+
+For use with your own organization [please contact us](mailto:[email protected]) to request an authentication key.
+
+If a private on-prem instance of the API is preferred, [see the instructions on the API repo](https://github.com/liquidvotingio/api) on how to use the docker image.
+
+## Running locally, with a local API instance
 
 For development, when running a Decidim instance locally with this module bundled, if you want to also run an API instance locally, you'll need to export the following env vars before starting Decidim: