Skip to content

Commit

Permalink
Update README text
Browse files Browse the repository at this point in the history
  • Loading branch information
oliverbarnes committed May 28, 2021
1 parent 2940f64 commit 2da9824
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:[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.

## 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"
Expand All @@ -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:

Expand Down

0 comments on commit 2da9824

Please sign in to comment.