diff --git a/README.md b/README.md index 2124672..22653dc 100644 --- a/README.md +++ b/README.md @@ -8,4 +8,25 @@ to tools ot manage and monitor your project under development environment. - install uv - git clone +## Run + +```bash +uv run src/main.py +``` + ## Your `.json` file + +You need one of this file per project configuration, it gives DxCompanion all the information to help you manage your project. + +This is a json file which can look like this : +```json +{ + "path": "/path/to/project/directory", + "project_name": "Name of your project", + "package_managers": ["uv"] +} +``` + +Configuration options : + +- `package_managers`: it's a list of packages manager to use with your project, actually supported are `composer` and `uv`