diff --git a/README.md b/README.md index 69a3391..8dd94d9 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,7 @@ See [CONTRIBUTING.md](https://github.com/lukew3/mathgenerator/blob/main/CONTRIBU ## Table of Contents * [Installation](#installation) -* [Basic Usage](#basic-usage) - * [More Complicated Usage](#more-complicated-usage) -* [Documentation](#documentation) +* [Usage](#usage) * [List of Generators](#list-of-generators) * [algebra](#algebra) * [basic_math](#basic_math) @@ -56,12 +54,16 @@ ws.write_pdf() ``` This creates the pdf `ws.pdf` in your current directory --> -`genById(id)` generates a problem, solution set with generator id `id` in the format `[problem, solution]` +Problem/solution pairs are generated with either: +* `mathgen.()` - generates a problem, solution set from the given generator name. +* `mathgen.genById(id)` - generates a problem, solution set with generator id `id` in the format `[problem, solution]` + + You can also use `getGenList()` to return a list of all generators in the repository in the format `[id, title, self, funcname, subjectname]`