docs: update the README

Author: bartekjaszczak

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "practicestuff"
-version = "0.0.26"
+version = "0.1.0"
 description = "Simple CLI trainer for improving calculation and memorisation skills"
 authors = ["Bartłomiej Jaszczak"]
 repository = "https://gitlab.com/bartekjaszczak/practicestuff"

Cargo.toml

@@ -2,71 +2,75 @@
 
 This is a work in progress and not all functionalities may function correctly (or even be implemented).
 
-# Idea
+# practicestuff
 
-CLI app designed to help you practice skills by asking questions and checking your answers.
+**practicestuff** is a CLI app designed to help you practice skills by asking questions and checking your answers. At the end, you'll see a number of correct answers, as well as some statistics. You can stop early by pressing `Ctrl+C`.
 
-Initial list of skills:
+The application should work on all platforms.
 
-- powers of a digit
-- multiplication table (times table)
-- doomsday algorithm
+List of skills:
 
-## Assumptions
+- powers of a number
+- multiplication table (times table) (not yet implemented)
+- doomsday algorithm (not yet implemented)
 
-- User has to choose a mode (skill) and optionally some flags/settings
-- User is presented with a number of questions for certain skill and has to type a correct answer
-- User should be able to quit at any time
-- Some statistics should be presented (accuracy, response time, overall time)
-- There should be a help tooltip
-- Program should return 0 on 100% accuracy
-- Algorithm parsing should be done without `clap` or any other library
-
-## General options
-- Option to set number of questions (default: 20, 0 means endless mode)
-- Option to show current accuracy between questions (default: true). Overall accuracy is presented at the end nevertheless
-- Option to exit early by typing 'q', 'e' or similar
-- Option to change behaviour on incorrect answer: continue to next question, show correct answer and continue, repeat (default: show correct & continue)
+## Configuration options
 
-## Specific options
+The application is somewhat configurable. Following options are available:
 
-### Powers
-
-- Option to set power base (default: 2)
-- Option to set upper and lower power boundary (default: 1 to 16)
-
-### Multiplication table
+- Custom number of questions (with a possibility of endless mode)
+- Disable statistics in-between questions
+- Change what happens on incorrect answer (go to the next question, show correct answer and go to the next question or repeat until correct)
 
-- Option to set upper and lower number boundary (default: 1 to 10)
+## Skills
 
-### Doomsday algorithm
+### Powers
 
-- Option to set start and end date (default: ±100 years 80% of the time, ±400 years 20% of the time; or normal distribution)
+Allows to practice powers. Configurable parameters include:
 
-# TODO
+- base (default: 2)
+- exponent range (default: 1-16)
 
-## General
+# Development
 
-DONE
+## Initial assumptions
 
-## Powers
+- User has to choose a mode (skill) and optionally some flags/settings
+- User is presented with a number of questions for certain skill and has to type a correct answer
+- User should be able to quit at any time
+- Some statistics should be presented (accuracy, response time, overall time)
+- There should be a help flag available
+- Argument parsing should be done without `clap` or any other library
+- There should be some options to be set:
+    - Option to set number of questions (including endless mode)
+    - Option to show current accuracy between questions (default: true). Overall accuracy is presented at the end nevertheless
+    - Option to exit early
+    - Option to change behaviour on incorrect answer: continue to next question, show correct answer and continue, repeat
+- It should be relatively easy to add new skills
+- All skills should be configurable
 
-DONE
+## Current TODO
 
-## Doomsday
+### Doomsday
 
 - help & usage prompts
 - question generation w/ options
 - tests
 
-## Multiplication table
+### Multiplication table
 
 - help & usage prompts
 - question generation w/ options
 - tests
 
-## Improvements
+### Improvements
 
 - coloured output (termcolor?) with --no-color option
 - additional mode (as many answers in given time)
 - multiple texts for "correct" and "incorrect" answers
+
+## What's next & bug reports
+
+The application in its current state suits my needs, but I'm open for proposals, either for new skills to practice or more configurability. If you feel that the app lacks something, feel free to open an issue or a PR! I'd be more than happy.
+
+As for the bugs, there are some for sure. If you see one, report it!