Skip to content

Commit 6a4af20

Browse files
committed
update readme
1 parent 25126fc commit 6a4af20

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ A single application to spin up your entire dev stack.
1010

1111
## About
1212

13-
`StackUp` is a tool for developers that automates the process of spinning up complicated development environments. It allows you to defines a series of steps that execute in order on startup and shutdown, as well as a list of server processes that should be started. Additionally, `StackUp` runs an event loop while the server processes are running, allowing you to run tasks on a cron schedule.
13+
`StackUp` is a scriptable tool for developers that automates the process of spinning up complicated development environments. It allows you to defines a series of steps that execute in order on startup and shutdown, as well as a list of server processes that should be started. Additionally, `StackUp` runs an event loop while the server processes are running, allowing you to run tasks on a cron schedule.
1414

1515
One of the key features of this application is its ability to automate routine tasks. With a simple configuration, you can define a sequence of tasks that your project requires, such as starting containers, running database migrations, or seeding data. This automation not only saves you time but also ensures consistency across your development environment.
1616

17-
It also includes a robust precondition system. Before doing anything, checks can be performed to ensure everything is set up correctly. This feature helps prevent common issues that occur when the environment is not properly configured.
17+
It also includes a robust, scriptable precondition system. Before doing anything, checks can be performed to ensure everything is set up correctly. This feature helps prevent common issues that occur when the environment is not properly configured.
1818

1919
## Running StackUp
2020

21-
To run `StackUp`, simply run the binary in a directory containing a `stackup.yaml` configuration file:
21+
To run `StackUp`, simply run the binary in a directory containing a `stackup.yaml` or `stackup.dist.yaml` configuration file:
2222

2323
```bash
2424
stackup
@@ -36,6 +36,12 @@ To generate a new configuration file to get started, run `init`:
3636
stackup init
3737
```
3838

39+
`StackUp` checks if it is running the latest version on startup. To disable this behavior, use the `--no-update-check` flag:
40+
41+
```bash
42+
stackup --no-update-check
43+
```
44+
3945
## Configuration
4046

4147
The application is configured using a YAML file named `stackup.yaml` and contains five sections: `preconditions`, `tasks`, `startup`, `shutdown`, and `scheduler`.

0 commit comments

Comments
 (0)