Skip to content

Commit

Permalink
doc: leverage github's support for Notes rendering
Browse files Browse the repository at this point in the history
Signed-off-by: Nick Mitchell <[email protected]>
  • Loading branch information
starpit committed Jul 26, 2024
1 parent 6089d39 commit 3cdcdba
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 30 deletions.
48 changes: 19 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,14 @@

Lunchpail compiles your job code into an all-in-one executable. Others download that binary, and `up` it to run your code in the Cloud or an existing Kubernetes cluster.

> [!NOTE]
> Bear with us, and please chip in if you can, as we finish up the initial polishing passes.
<table>
<tr>
<td><img src="docs/demo1.gif" width="222"></td>
<td><img src="docs/status0.png" width="230"></td>
<td><img src="docs/status1.png" width="230"></td>
</tr>
<tr>
<td><a href="docs/demos/#openroad-demo"><tt>lunchpail-openroad up</tt></a></td>
<td><a href="docs/demos/#lunchpail-demo"><tt>lunchpail-demo up</tt></a></td>
<td>Commercial app</td>
<td><img src="docs/demo1.gif" width="222"><br><a href="docs/demos/#openroad-demo"><tt>lunchpail-openroad up</tt></a></td>
<td><img src="docs/status0.png" width="230"><br><a href="docs/demos/#lunchpail-demo"><tt>lunchpail-demo up</tt></a></td>
<td><img src="docs/status1.png" width="230"><br>Commercial application</td>
</tr>
</table>

Expand All @@ -30,26 +28,18 @@ Lunchpail compiles your job code into an all-in-one executable. Others download

Here are some of the Lunchpail use cases, summarized by user role:

<table>
<tr>
<td>
<strong>Application Owners</strong> shrink-wrap and distribute code as binaries. Lunchpail bundles your code with the logic for deployment, scaling, load balancing, observability, etc.
</td>
<td>
<strong>Platform engineers</strong> can shrink-wrap the variants of base application logic for their team's use cases. These also become distributable binaries.
</td>
</tr>
<tr>
<td>
<strong>End users</strong> or <strong>automators</strong> can stitch together the steps of automation, because each step is a black box shrink-wrapped application.
</td>
<td>
<strong>Budgeters</strong> and <strong>managers</strong> can have their developers run the applications in a mode that only queues up work. Separately, one can use the same binary to allocate or reduce resources assigned to each queue, as budget allows.
</td>
</tr>
</table>
### Application Owners

Shrink-wrap and distribute code as binaries. Lunchpail bundles your code with the logic for deployment, scaling, load balancing, observability, etc.

### Platform engineers

Shrink-wrap the variants of base application logic for their team's use cases. These also become distributable binaries.

### End users and Automators

Stitch together the steps of automation, because each step is a black box shrink-wrapped application.

## And... Welcome!
### Budgeters and Project Managers

Lunchpail is a new project. Bear with us, and please chip in if you
can, as we finish up the initial polishing passes.
Have your developers run the applications in a mode that only queues up work. Separately, one can use the same binary to allocate or reduce resources assigned to each queue, as budget allows.
3 changes: 2 additions & 1 deletion docs/demos/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ Welcome to the Lunchpail demo page. The demo binaries described here
are all products of Lunchpail. Look [here](../build/README.md) for
guidance of building your own binaries.

> Note: the demo commands below currently assume that you have a valid
> [!IMPORTANT]
> The demo commands below currently assume that you have a valid
> Kubernetes context. Cloud VM support and support for bringing up a
> local [Kind](https://github.com/kubernetes-sigs/kind) cluster will
> be documented soon.
Expand Down

0 comments on commit 3cdcdba

Please sign in to comment.