Skip to content

Commit f8c8f4c

Browse files
author
Florian Heinze
committed
TASK: updated README
1 parent ca09537 commit f8c8f4c

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,38 +23,38 @@ This helper allows running tasks from inside a nested folder structure ;)**
2323
On the way up, the first `dev.sh` marked with a comment containing `DEV_SCRIPT_MARKER` is used to
2424
execute a task.
2525

26-
We want the API to be the same when running the `dev.sh` script directly or by using the helper.
26+
We want the API of the helper to be the same as running the `dev.sh` script directly.
2727
This is why we decided to NOT introduce a `run` argument for this helper.
2828

29-
When thinking about ...
29+
This is how we ended up with the following API to run your tasks.
3030

31-
`./dev.sh sometask` & `dev run sometask` vs.
32-
33-
`./dev.sh sometask` & `dev sometask` then
34-
35-
`./dev.sh sometask` & `dev sometask` **is the clear winner ;)**
31+
`./dev.sh sometask` or `dev sometask`
3632

3733
Some functionality will only be provided by the helper, e.g. running an init.
38-
As we do not want to confuse this additional functionality with running a task, we use UPPERCASE arguments for the API.
34+
As we do not want to confuse this additional functionality with running a task, we use UPPERCASE arguments for the helper API.
3935

4036
Example: `dev INIT` to create the files needed in your project.
4137

38+
**You should not use UPPERCASE tasks in your `dev.sh`!**
39+
4240
## Setup
4341

4442
run `brew install sandstorm/tap/dev-script-runner` to install
4543

4644
run `brew upgrade sandstorm/tap/dev-script-runner` to upgrade
4745

48-
Go to your project root and run `dev INIT`to create a `dev.js` with examples for different types of tasks.
46+
Go to your project root and run `dev INIT` to create a `dev.sh` and a `dev_setup.sh` with examples for different types of tasks.
4947
The `$@` at the end of your `dev.sh` dispatches the script arguments to a function (so `dev sometask` calls `sometask`).
5048

5149
The script is only picked up by the helper if `DEV_SCRIPT_MARKER` is present in the file.
5250

5351
## Usage
5452

55-
`dev <TASK_NAME>` to run a task
53+
`dev <TASK_NAME> [ARGUMENTS]` to run a task
5654

5755
`dev INIT` to create the files needed in your project
5856

5957
## TODOs
58+
6059
* Autocompletion for tasks
60+
* Testing

0 commit comments

Comments
 (0)