From 91e9a8e0fd16a5649b20abf5d5115da5f1f3ced5 Mon Sep 17 00:00:00 2001 From: Les De Ridder Date: Tue, 23 Oct 2018 03:04:28 +0200 Subject: [PATCH] Add readme --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..008c28d --- /dev/null +++ b/README.md @@ -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.