From 9487243c4ec31089936f1cec1f087ff949f6c9f2 Mon Sep 17 00:00:00 2001 From: LyubomirT Date: Sat, 2 Dec 2023 13:09:39 +0200 Subject: [PATCH] Add documentation and examples section for basic usage category of README. --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 016340d..1d3fcdc 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,8 @@ python demo.py LESP is pretty easy to setup, and basic demo configuration is already pre-built. You can find it in `demo_config` (this is a file, not a folder!) and you can edit it to your liking. Note that the file is **required** for the demo to run, so don't delete, move, or rename it. Not required for installing it with `pip` though (coming soon). +If you want to take a closer look at how to use LESP, you can check out our [documentation](https://lesp.gitbook.io/lesp). There we have a detailed explanation of how to use LESP, along with some examples. If you're still not sure how to use LESP, you can check out the `examples` folder. It contains some examples of how you can use LESP in your projects. These examples are pretty simple, but they should give you an idea of how you can use LESP in your projects. + ### Basic usage To use LESP, you need to import the `Proofreader` class from the `lesp` module. The class has a decent amount of functions, but the most important ones are `is_correct` and `get_similar`. Here's an example: