diff --git a/README.md b/README.md index 43e1add..0cd66a0 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,17 @@ # Project Manager +Automatically detects modules and executes commands + +Supported types: + +- python (poetry) +- nodejs (npm) +- docker + ## Install ```bash -pipx install project-manager -i https://git.shmyga.ru/InfernalGames/project-manager/packages +pipx install project-manager -i https://git.shmyga.ru/api/packages/InfernalGames/pypi/simple/ --pip-args="--extra-index-url https://pypi.org/simple" ``` ## Usage @@ -14,17 +22,16 @@ pipx install project-manager -i https://git.shmyga.ru/InfernalGames/project-mana pm [-v] [-vv] ``` +![pm show](docs/Screenshot_0.png "pm show") + ### Run task ```bash -pm [:] [-v] [-vv] +pm [:][:] [-v] [-vv] ``` -## Presets locations - -- default presets [`project_manager/preset/default/*.toml`](./project_manager/preset/default) -- user preset `$HOME/.pm.toml` -- project preset `./.pm.toml` +![pm lint](docs/Screenshot_1.png "pm lint") +![pm build](docs/Screenshot_2.png "pm build") ## Preset format @@ -39,3 +46,9 @@ commands = [""] ### Examples [Default presets](./project_manager/preset/default) + +## Presets locations + +- default presets [`project_manager/preset/default/*.toml`](./project_manager/preset/default) +- user preset `$HOME/.pm.toml` +- project preset `./.pm.toml` diff --git a/docs/Screenshot_0.png b/docs/Screenshot_0.png new file mode 100644 index 0000000..b383d3d Binary files /dev/null and b/docs/Screenshot_0.png differ diff --git a/docs/Screenshot_1.png b/docs/Screenshot_1.png new file mode 100644 index 0000000..9db809e Binary files /dev/null and b/docs/Screenshot_1.png differ diff --git a/docs/Screenshot_2.png b/docs/Screenshot_2.png new file mode 100644 index 0000000..1b8dbd4 Binary files /dev/null and b/docs/Screenshot_2.png differ