voterunner

commit

46f1233c57823c9af29de407ff4a98f916e59e59

parent

883ed2cadf7164e0ed4772a9c71aacc96f884e86

Author

Tobias Bengfort <tobias.bengfort@posteo.de>

Date

2020-10-18 09:47

improve readme

Diffstat

1 files changed, 20 insertions, 26 deletions

diff --git a/README.md b/README.md

@@ -1,32 +1,11 @@
    1     1 voterunner
    2     2 ==========
    3     3 
    4    -1 what is this?
    5    -1 -------------
    6    -1 
    7    -1 This app tries to allow for quick and dirty votes and discussions. It is
    8    -1 basically the core concept behind
    9    -1 [votorolla](http://zelea.com/project/votorola/home.xht) mixed with the
   10    -1 interface of [etherpad](http://etherpad.org/). Technically, it is a lot
   11    -1 of client side code using a [via](https://github.com/xi/via) server.
   12    -1 
   13    -1 The voting mechanism
   14    -1 --------------------
   15    -1 
   16    -1 Votorolla is a complex liquid democracy project. But the core idea is
   17    -1 simple:
   18    -1 
   19    -1 Every opinion is a node in a tree. At first, there are no edges at all.
   20    -1 So people start to explain why their opinion is the one to choose. When
   21    -1 you see some convincing argument you can *support* that node (*delegate
   22    -1 your vote*).
   23    -1 
   24    -1 After a while it becomes clear which competing positions exist and which
   25    -1 arguments are important. The whole discussion is conserved in the graph.
   26    -1 You can go on discussing until you reach a consensus.
   27    -1 
   28    -1 While this concept is not perfect for every situation it is beautiful
   29    -1 in its simplicity.
   -1     4 Voterunner combines public [delegated
   -1     5 voting](https://en.wikipedia.org/wiki/Liquid_democracy) with real-time
   -1     6 communication inspired by [etherpad](http://etherpad.org/). While this
   -1     7 concept is not perfect for every situation it is beautiful in its
   -1     8 simplicity.
   30     9 
   31    10 How to use it
   32    11 -------------
@@ -59,6 +38,21 @@ the delegation. Now you compete directly with other ideas. Maybe you can
   59    38 convince others, but maybe you should delegate your vote again in order
   60    39 to agree on a compromise.
   61    40 
   -1    41 Once everyone agrees on a single proposal you not only have a decision
   -1    42 but also a record of all the little arguments that lead you there.
   -1    43 
   -1    44 Limitations
   -1    45 -----------
   -1    46 
   -1    47 This uses a very simple [via](https://github.com/xi/via) backend which
   -1    48 comes with a set of limitations:
   -1    49 
   -1    50 -	No protection against manipulation (but users can verify their own
   -1    51 	votes)
   -1    52 -	No protection against data loss
   -1    53 -	No builtin authentication
   -1    54 -	All data will be deleted after 2 weeks of inactivity
   -1    55 
   62    56 Development
   63    57 -----------
   64    58