Update README. Started docs.

This commit is contained in:
Boyan 2024-02-13 20:35:26 +01:00
parent 6fd30d10ed
commit 403ac01e89
2 changed files with 15 additions and 3 deletions

11
.readthedocs.yaml Normal file
View File

@ -0,0 +1,11 @@
# Required
version: 2
# Set the OS, Python version and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.12"
sphinx:
configuration: docs/conf.py

View File

@ -2,10 +2,11 @@ A python library which interacts with themis. Use selenium and bs4. I'll try to
## Intended Features
* [x] Log in
To log in, go to the `config.py` file and replace the username and password field with yours. You can now continue to use the rest of the library.
* [ ] Classes, methods and attributes described in the map below
## Docs
[here](http://temmies.rtfd.io/). Heavily WIP.
## Class map
![map](images/roadmap.png)