diff --git a/image/README.md b/image/README.md index 1d4e32b..eb0b5fa 100644 --- a/image/README.md +++ b/image/README.md @@ -33,4 +33,4 @@ run() { janikvonrotz/taskfile.build:latest ``` -The entrypoint script of the container will clone the project from git url. If the project is already cloned it will pull the origin. Afterwards if runs each command in the root the of the cloned repository with the task file `./task `. Finally the Caddy webserver is started that serves static content from the root path. +The entrypoint script of the container will clone the project from git url. If the project is already cloned it will pull the origin. Afterwards it runs each command in the root of the cloned repository with the task file `./task `. Finally the Caddy webserver is started that serves static content from the root path. diff --git a/usage.md b/usage.md index c681b35..296cc52 100644 --- a/usage.md +++ b/usage.md @@ -8,16 +8,18 @@ It is recommended to use simple shell alias to run the task file: `alias task='. Start with showing the available commands: `task help` -You should get an ouput like this: +You should get an output like this: ```bash task [options] commands: -| Command | Option | Description | -|----------------------|------------|--------------------------------------------| -| all | | Run all tasks. | +| Command | Option | Description | +|----------------------|--------|--------------------------------------| +| all | | Run all tasks. | +| install | | Install build dependencies. | +| lint | | Lint code with prettier. | ... ``` @@ -82,7 +84,7 @@ See [taskfile.build/image](/image) for details. Instead of setting up a task file for every ptoject, you can also set up only one with a fallback to the task file in the `$PWD`. -First create symlink from your shell bin folder to the template task file. It is recommended to use the `$HOME/.local/bin/` folder. +First create symlink from your shell bin folder to the task file template. It is recommended to use the `$HOME/.local/bin/` folder. Create the symlink: @@ -90,7 +92,7 @@ Create the symlink: ln -sf "$HOME/taskfile.build/task.template" "$HOME/.local/bin/task" ``` -Add this config to your shell profile: +Then add this config to your shell profile: ```bash export PATH="$HOME/.local/bin:$PATH"