diff --git a/README.md b/README.md index e139b43..30f4434 100644 --- a/README.md +++ b/README.md @@ -270,12 +270,22 @@ swift run -c release ResgenSwift generate path/to/configuration.yml --project-di > ⚠️ Every path in `configuration.yml` will be prepended by content of `--project-directory` if they are relative path (not starting with `/`) -## Installation +## Binary usage -Simple run `./install.sh`. Binary will be install in `/usr/local/bin`. Then, use ResgenSwift like any other command: +### Installation -Example: +Run `make install`. Binary will be install in `/usr/local/bin`. + +Usage: ```sh -ResgenSwift generate path/to/configuration.yml --project-directory ${PROJECT_DIR} +resgen-swift generate path/to/configuration.yml --project-directory ${PROJECT_DIR} ``` + +### Man page + +Commands parameters and details can be find by running `resgen-swift --help`. If you prefer, a man page is also available. Run `man resgen-swift`. Man page is installed on `make install` but you can install manually by running `make create-and-install-man-file`. + +### Uninstallation + +To uninstall ResgenSwift: `make uninstall`.