Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jeckel committed Nov 12, 2024
1 parent b1c3d90 commit 8dba8b7
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <project-file.json>
```

## Your `<project-name>.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`

0 comments on commit 8dba8b7

Please sign in to comment.