Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alexec authored Dec 25, 2022
1 parent 7ec742e commit 905d2e2
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This is a tool to enable local development of containerized applications.

It allows you to specify a set of process that run in **containers** or on the **host**. The process are run concurrently and their status is **muxed into a single terminal** window to you're not overwhelmed by output. We **probe** your procoss to see if it's gone wrong, automatically restarting it. When you're done, **ctrl+c** to and they're all cleanly stopped. **Logs are captured** so you can look at the anytime.
It allows you to specify a set of process that run in **containers** or on the **host**. The process are run concurrently and their status is **muxed into a single terminal** window (so you're not overwhelmed by output). It **probe** your processes to see if they've gone wrong, automatically restarting them. When you're done, **ctrl+c** to and they're all cleanly stopped. **Logs are captured** so you can look at them anytime.

It's arguably the mutant offspring of other tools:

Expand All @@ -13,8 +13,7 @@ It's arguably the mutant offspring of other tools:
| `podman play kube` |||||| ✔? |
| `foreman run` |||||||

⚠️ Volumes are not yet supported.

Volumes are not yet supported.

## Install

Expand All @@ -28,7 +27,7 @@ brew install kit
Describe you application in a [`kit.yaml`](kit.yaml) file using Kubernetes pod syntax, then start:

```bash
kit
kit up
```

You'll see something like this:
Expand Down Expand Up @@ -65,7 +64,7 @@ starts.
### Host Process
The `image` field is empty. The value of `command` is used to start the process.
If `image` field is omitted, the value of `command` is used to start the process on the host:

```yaml
# no image? this is a host process
Expand Down

0 comments on commit 905d2e2

Please sign in to comment.