docs: add badges to the README, and a short video

master
Dominique Merle 4 years ago
parent d2de140a44
commit cd73860f9a

@ -1,18 +1,23 @@
[![Join the Discord chat at https://discord.gg/rAAQG9S](https://img.shields.io/discord/705322981102190593.svg)](https://discord.gg/rAAQG9S)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
# Majority Judgment Polling (for Streamers) # Majority Judgment Polling (for Streamers)
Make a majority judgment poll in a few seconds _(as low as 0.5s, by hitting `Enter` twice)_, and let your community vote on it through one of the _providers_, like your Twitch Chat, using commands such as `A2 B1 C4`. Organize a majority judgment poll in a few seconds _(as low as 0.5s, by hitting `Enter` twice)_, and let your community vote on it through one of the _providers_, like your Twitch Chat, using commands such as `A2 B1 C4`.
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/6JnTlUcu1nA" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
## Overview ## Overview
This is a distributable project made with Godot Game Engine, and there is no server-side to this application. This is a distributable project made with Godot Game Engine, and there is no server-side to this application.
All the data is held by the streamer, on their computer, All the data is held by the streamer, on their computer, whether they're using a binary executable or the web application on _itch.io_.
whether they're using a binary or the web application on _itch.io_.
By design, the ballots are open, which may be unsuitable for politics, but it will allow us to enable delegation features, and we find that exciting! By design, the ballots are open, which may be unsuitable for politics, but it will allow us to enable delegation features, and we find that exciting!
Perhaps there is a way to close the ballots (using whispers, a twitch js overlay or some other trick). Perhaps there is a way to close the ballots (using whispers, a Twitch js overlay or some other trick).
## Disclaimer ## Disclaimer
@ -21,9 +26,7 @@ The project is in a **PRIVATE ALPHA** stage.
We're looking for streamers willing to test it out and help us improve the software by making it crash in a number of interesting ways. We're looking for streamers willing to test it out and help us improve the software by making it crash in a number of interesting ways.
Open an issue in our tracker and help us ! Open an issue in our tracker, or join us on [Discord](https://discord.gg/rAAQG9S).
Join us on Discord : https://discord.gg/dDnfWD
## Chat Commands ## Chat Commands
@ -65,6 +68,8 @@ We may support different gradings in the future.
- Option to change the background color - Option to change the background color
- Save/Load polls (only the GUI left to do) - Save/Load polls (only the GUI left to do)
- Resilience to scale (Poll tallier may be vastly improved) - Resilience to scale (Poll tallier may be vastly improved)
- Option to enable/disable logs
- Allow candidates to be added by the Chat
- … - …

Loading…
Cancel
Save