From 847bbb4a2c5663d21836713adc846c9d26e46d63 Mon Sep 17 00:00:00 2001 From: domi41 Date: Sun, 6 Sep 2020 05:16:37 +0200 Subject: [PATCH] docs: Review the README --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3661704..d1eb30c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,20 @@ # Mieux Voter OpenAPI Definition -TODO: -CI on Jenkins +This reposority hosts the OpenAPI specification for the API of MieuxVoter, +a Majority Judgment polling application spearheaded by the french nonprofit +[MieuxVoter.fr](https://mieuxvoter.fr). + + +## TODO + +- [x] Draft a spec +- [ ] CI on Jenkins +- [ ] Link to generated doc/sandbox +- [ ] Localization (how?) +- [ ] … + + +----- ## Working on your OpenAPI Definition @@ -22,6 +35,7 @@ Bundles the definition to the dist folder. #### `npm test` Validates the definition. + ## Contribution Guide Below is a sample contribution guide. The tools