📝 Update documentation.

Author: rafalkrupinski

Readme.md

@@ -3,3 +3,13 @@
 [![.github/workflows/test.yml](https://github.com/python-lapidary/lapidary-render/actions/workflows/test.yml/badge.svg)](https://github.com/python-lapidary/lapidary-render/actions/workflows/test.yml)
 
 Lapidary-render is a program that generates Python Web API clients from OpenAPI documents.
+
+## Why
+
+OpenAPI is a machine readable description of Web APIs. A large subset of it is very well suited for automatic translation to a client code.
+
+## How
+
+Lapidary render uses [Jinja](https://jinja.palletsprojects.com/) to generate client code, but most of the translation from OpenAPI to python is implemented in python itself. This makes it easier to read and maintain the generator itself.
+
+Instead of generating large pieces of code that convert data and call http libraries, Lapidary generates code that uses [Lapidary runtime library](https://github.com/python-lapidary/lapidary). It's also a way to greatly simplify the code, at the expense of small runtime overhead related to processing method signatures.

docs/index.md

@@ -47,16 +47,23 @@ Renders the client code in the project root. The default project root is the cur
 
 All python files are generated in the `PROJECT_ROOT/gen` directory.
 
-If the patches directory (`PROJECT_ROOT/src/patches` by default) exists, Lapidary will read all JSON and YAML files
-and apply them as JSONPatch files against the original OpenAPI file.
-
 ## Configuration
 
 Lapidary can be configured with a `pyproject.yaml` file of the client project, under `[tool.lapidary]` key.
 
-- package - root package name.
-- document_path - path of the OpenAPI document, relative to the project root.
-- origin - URL of the OpenAPI document, used when document_path is missing, or when `servers` is not defined, or the first server URL is a relative path.
-- patches - patches directory [default = 'src/patches'].
+package
+: root package name.
+
+document_path
+: path of the OpenAPI document, relative to the project root.
+
+origin
+: URL of the OpenAPI document, used when document_path is missing, or when `servers` is not defined, or the first server URL is a relative path.
+
+extra_sources
+: list of additional source roots for manually written code. The files will be interpreted as templates, but non-template files will also work.
+
+plugins
+: list of plugin classes. See [the section on plug-ins](/plugins)
 
 At least one of `document_path` and `origin` is required. Saving OpenAPI document in the project is recommended for repeatable builds.