From 8630fb89e2cb975536181cf30a03a2607a209e1b Mon Sep 17 00:00:00 2001 From: Alisson Lauffer Date: Sun, 22 Oct 2023 22:12:08 -0300 Subject: [PATCH] add readme explaining project branches --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..3b23294d --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ + + +# UserLixo + +Multipurpose Python userbot for Telegram + +## Before you start + +This project is divided into two active branches, developed by different people. Each one strives to meet the needs of their respective users. The branches are: + +- [userlixo-czp](https://github.com/AmanoTeam/UserLixo/tree/userlixo-czp): + - Mainly developed by [Cezar](https://github.com/usernein). + - Uses a more complex code structure. + - Supports installing plugins from the web. + - Has a web configuration interface. + - Supports multiple database engines (through ORM). + +- [userlixo-rfc](https://github.com/AmanoTeam/UserLixo/tree/userlixo-rfc): + - Mainly developed by [Rian](https://github.com/RianFC). + - Maintained by the original creator of the project. + - Uses a simpler code structure. + - Only supports SQLite as database. + +To clone the branch you selected, please use the following command: + +```shell +git clone https://github.com/AmanoTeam/UserLixo -b +```