From 2da9824c8e1d4998995b4fa91b2b8ddf546536aa Mon Sep 17 00:00:00 2001 From: Oliver Azevedo Barnes Date: Fri, 28 May 2021 16:28:50 +0200 Subject: [PATCH 1/2] Update README text --- README.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 9a6fa1b..22c0406 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,27 @@ [![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/). +**In alpha** -**WIP - not ready for production** +Hasn't been used in production yet. But it's ready for a pilot! -## Usage +## What -Liquidvoting will be available as a Component for a Participatory -Space. +Integrates Decidim with the [liquidvoting.io API](https://www.liquidvoting.io/api). + +Enables delegations of supports for proposals in participatory processes and assemblies. + +Redirects supports so they go through the API, in order to calculate results based on different voting weights of delegates. + +By default this will connect the instance 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:info@liquidvoting.io) 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. ## 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 +34,7 @@ And then execute: bundle ``` -## Running locally, with local API instance +## 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: From c102d4e69ee31c24e328965b6657df0863e99424 Mon Sep 17 00:00:00 2001 From: Oliver Azevedo Barnes Date: Fri, 28 May 2021 15:38:22 +0100 Subject: [PATCH 2/2] Update README - add video and tweak text a bit more --- README.md | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 22c0406..36f1fe9 100644 --- a/README.md +++ b/README.md @@ -2,23 +2,14 @@ [![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) -**In alpha** - -Hasn't been used in production yet. But it's ready for a pilot! - -## What - Integrates Decidim with the [liquidvoting.io API](https://www.liquidvoting.io/api). -Enables delegations of supports for proposals in participatory processes and assemblies. +**Note: In alpha**. Not yet used in production. But it's ready for a pilot! -Redirects supports so they go through the API, in order to calculate results based on different voting weights of delegates. +https://user-images.githubusercontent.com/21290/120000386-a952b180-bfca-11eb-9e94-82b875048b6b.mp4 -By default this will connect the instance with the live api hosted on https://api.liquidvoting.io/, and use a demo organization there. +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. -For use with your own organization [please contact us](mailto:info@liquidvoting.io) 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. ## Installation @@ -34,6 +25,12 @@ And then execute: bundle ``` +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:info@liquidvoting.io) 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: