From 3b5df010c0692a1fab819a5ac6665a382eb368e7 Mon Sep 17 00:00:00 2001 From: randomchars42 Date: Sun, 11 Jun 2017 14:26:30 +0200 Subject: [PATCH] improve Readme.md --- Readme.md | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/Readme.md b/Readme.md index 26cae99..668f467 100644 --- a/Readme.md +++ b/Readme.md @@ -4,14 +4,17 @@ Server component of a suite for students to create multiple-choice questions to ## Features -A CRUD API which allows: +A PHP-based CRUD API. You can: -* creating and maintaining of an arbitray number of collections of multiple-choice questions -* filtering of collections -* creating and maintnaining individual test sessions for each user -* markdown / flatfile based note collections to share experiences / tips between users -* creating and maintaing of users (incl. password reset) -* ... +* add / modify / delete / undelete / reset `modules` - a collection of multiple-choice questions +* add / modify / delete / undelete / reset `mcqs` - the multiple-choice questions +* add / modify / delete `sessions` - test your knowledge against an individual collection of `mcqs` +* invite / modify / manage / delete `users` +* supports a simple hierarchy consisting of admins and users +* add / modify / delete `exams` - arbitrary collection of notes +* add / modify / delete `protocolls` - arbitrary flatfile / markdown-based notes for `exams` to share impressions, tips and help + +*reset* means that old revisions of those items are kept by the server so one can go back and restore an arbitrary version ## First Steps @@ -67,6 +70,6 @@ PATCH version when you make backwards-compatible bug fixes. To mark pre-releases you may add: -* `-rc[0-9]*` for release-candidates -* `-beta[0-9]*` for beta-releases -* `-alpha[0-9]*` for alpha-releases +* `-rc.[0-9]*` for release-candidates +* `-beta.[0-9]*` for beta-releases +* `-alpha.[0-9]*` for alpha-releases