add screenshots (#82)

decidim-vocdoni · May 22, 2024 · f87f74c · f87f74c
1 parent 029cc01
commit f87f74c
Show file tree

Hide file tree

Showing 8 changed files with 25 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -5,7 +5,8 @@
 [![Maintainability](https://api.codeclimate.com/v1/badges/126b8ece66b8292802f3/maintainability)](https://codeclimate.com/github/decidim-vocdoni/decidim-module-vocdoni/maintainability)
 [![codecov](https://codecov.io/gh/decidim-vocdoni/decidim-module-vocdoni/branch/main/graph/badge.svg?token=LRT4MJBNVY)](https://codecov.io/gh/decidim-vocdoni/decidim-module-vocdoni)
 
-:warning: This module is under development and is not ready to be used in production.
+:warning: This module is a Beta stage, we recommend you to contact the authors before use it.
+This is specially relevant as voting using the blockchain has an economic cost.
 
 An elections component for Decidim's participatory spaces based on the [Vocdoni](https://vocdoni.app).
 
@@ -21,9 +22,30 @@ using the [Vocdoni SDK](https://vocdoni.io/).
 
 Vocdoni will be available as a Component for a Participatory Space.
 
-## Installation
+For installation instructions, [skip the screenshots section](#installation).
+
+## Screenshots
+
+A nice wizard to set up the election in the admin:
+
+![](docs/config_start.png)
+![](docs/config_calendar.png)
+
+Final checks and blockchain synchronization:
+
+![](docs/setup_election.jpg)
 
-This module is only compatible with Decidim v0.27.
+Voting in a non-distracting booth:
+
+![](docs/choosing_vote.png)
+![](docs/sending_vote.png)
+![](docs/vote_finished.png)
+
+Publication of results:
+
+![](docs/results.png)
+
+## Installation
 
 Add this line to your application's Gemfile:
 

diff --git a/docs/choosing_vote.png b/docs/choosing_vote.png
diff --git a/docs/config_calendar.png b/docs/config_calendar.png
diff --git a/docs/config_start.png b/docs/config_start.png
diff --git a/docs/results.png b/docs/results.png
diff --git a/docs/sending_vote.png b/docs/sending_vote.png
diff --git a/docs/setup_election.jpg b/docs/setup_election.jpg
diff --git a/docs/vote_finisihed.png b/docs/vote_finisihed.png