docs: update the README

Also, change the spelling of some words to British English

Author: bartekjaszczak

Cargo.lock

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

Cargo.toml

@@ -4,14 +4,14 @@ This is a work in progress and not all functionalities may function correctly (o
 
 # practicestuff
 
-**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`.
+**practicestuff** is a CLI app designed to help you practise 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`.
 
 The application should work on all platforms.
 
 List of skills:
 
 - powers of a number
-- multiplication table (times table) (not yet implemented)
+- multiplication table (times table)
 - doomsday algorithm (not yet implemented)
 
 ## Configuration options
@@ -26,11 +26,15 @@ The application is somewhat configurable. Following options are available:
 
 ### Powers
 
-Allows to practice powers. Configurable parameters include:
+Allows to practise powers. Configurable parameters include:
 
 - base (default: 2)
 - exponent range (default: 1-16)
 
+### Times table
+
+Allows to practise multiplications. Factors' range is configurable (default: 1-10 (regular times table)).
+
 # Development
 
 ## Initial assumptions
@@ -57,12 +61,6 @@ Allows to practice powers. Configurable parameters include:
 - question generation w/ options
 - tests
 
-### Multiplication table
-
-- help & usage prompts
-- question generation w/ options
-- tests
-
 ### Improvements
 
 - coloured output (termcolor?) with --no-color option
@@ -72,6 +70,6 @@ Allows to practice powers. Configurable parameters include:
 
 ## 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.
+The application in its current state suits my needs, but I'm open for proposals, either for new skills to practise 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!

README.md

@@ -16,9 +16,9 @@ pub const APP_NAME: &str = env!("CARGO_PKG_NAME");
 const VERSION: &str = env!("CARGO_PKG_VERSION");
 
 const COMMANDS: [help::Command; 2] = [
-    help::Command::new(powers::CMD, "Practice powers (configurable base)."),
-    help::Command::new(times_table::CMD, "Practice multiplication table."),
-    // help::Command::new(doomsday_algorithm::CMD, "Practice the Doomsday algorithm."),
+    help::Command::new(powers::CMD, "Practise powers (configurable base)."),
+    help::Command::new(times_table::CMD, "Practise multiplication table."),
+    // help::Command::new(doomsday_algorithm::CMD, "Practise the Doomsday algorithm."),
 ];
 
 pub struct Application;

src/application.rs

@@ -96,7 +96,7 @@ impl Powers {
             .default_value()
             .to_string();
 
-        format!("Practice powers with a customizable base and exponent range. By default, the base is {default_base}, with exponents ranging from {default_lower_boundary} to {default_upper_boundary}.")
+        format!("Practise powers with a customisable base and exponent range. By default, the base is {default_base}, with exponents ranging from {default_lower_boundary} to {default_upper_boundary}.")
     }
 
     fn build_arg_definitions() -> Vec<Arg> {

src/skill/powers.rs

@@ -92,7 +92,7 @@ impl TimesTable {
     }
 
     fn usage() -> String {
-        format!("Usage: {APP_NAME} [option]... times_table [timestable_option]...")
+        format!("Usage: {APP_NAME} [option]... times_table [times_table_option]...")
     }
 
     fn help_prompt() -> String {
@@ -115,7 +115,7 @@ impl TimesTable {
             .default_value()
             .to_string();
 
-        format!("Practice multiplication table with a customisable factor range. By default, the factor range mimics the normal times table ({default_lower_boundary}-{default_upper_boundary}).")
+        format!("Practise multiplication with a customisable factors' range. By default, the range of factors mimics the normal times table ({default_lower_boundary}-{default_upper_boundary}).")
     }
 
     fn build_err_message(msg: Option<String>) -> String {