Add readme

This commit is contained in:
Les De Ridder 2018-10-23 03:04:28 +02:00
parent 4ee2ffd30b
commit 91e9a8e0fd
1 changed files with 17 additions and 0 deletions

17
README.md Normal file
View File

@ -0,0 +1,17 @@
# pollthingy
A simple (straw) poll web application made with [Laravel 5.7](https://laravel.com).
## Features
* Many useful options (multiple answers, automatic closing of poll at a chosen date, hiding results until poll is closed, etc.)
* Optional duplication checking via generated voting codes
* Sane endpoints/'RESTful API' (with optional JSON output via HTTP Accept header)
* Simple CSS based on [Cutestrap](https://cutestrap.com)
* No JS is used
* Developed with support for text-based browsers in mind (including pie charts in w3m)
## API
TODO: Document the API.
## License
pollthingy is licensed under the University of Illinois/NCSA Open Source License.
The full license can be found in the [LICENSE](LICENSE) file.