Init

README.md

@@ -0,0 +1,58 @@
+# README
+
+## Clone
+
+use recursive
+
+```bash
+git clone --recursive <repository_url>
+```
+
+or
+
+```bash
+git clone <repository_url>
+cd Convention
+git submodule update --init --recursive
+```
+
+## First Start
+
+use
+
+```bash
+python app.py
+```
+
+to start and generate **Assets** Folder(generate by [ProjectConfig](Convention/Runtime/GlobalConfig.py))
+
+## Assets
+
+Every default argument define in **Assets/config.json**,
+properties in **find** is define the arguments value where you not setting
+
+Sometimes some property not exists in config,
+just because program not running to the place where argument been referenced
+
+## Arguments
+
+### Commandline and Config
+
+- **--main-webhook-url** main target of the message will be send, **needed**
+- **--host** default: 0.0.0.0
+- **--port** default: 8000
+- **--verbose** default: false
+
+### Only Config
+
+- **max_concurrent_requests** default: 100
+- **database_path** file on [Assets](Assets), default: db.db
+- **plugin_dir** where plugins load, default: Plugins
+
+## Plugins
+
+First import interface and define class
+```python
+from CoreModules.plugin_interface import PluginInterface, DatabaseModel
+class MyPlugin()
+```