Update readme

parent aa3d7f3f
......@@ -11,9 +11,13 @@ Usage:
`$ redirector-convert <.htaccess file> <.map file>` - convert .htaccess to .map file
`$ redirector-config --show` - show all current config.ini data
`$ redirector-config --edit <dir_key> <new_val>` - replace directory in config, which matching `<dir_key>` by `<new_val>`
## Structure
### Redirector:
`redirector/redirector.py:` **Redirector** - main class with single function - **generate(**_yaml_file, map_file_**)**, that generates _.conf_ and _.map_ files in _MAPS_DIR_ and _CONFIG_DIR_ directories, specified in `redirector/const.py`
`redirector/redirector.py:` **Redirector** - main class with single function - **generate(**_yaml_file, map_file_**)**, that generates _.conf_ and _.map_ files in _MAPS_DIR_ and _CONFIG_DIR_ directories, specified by `redirector/conf/config.ini`, also you can edit all the data from config, using `redirector-config --edit` or show all the config data using `redirector-config --show`
`redirector/generators.py:` **Generator** - class, that uses **MapGenerator** and **ConfigGenerator** for creating _.map_ and _.conf_ files.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment