Skip to content

Commit

Permalink
Added quick start to readme and intro
Browse files Browse the repository at this point in the history
  • Loading branch information
F1bonacc1 committed Dec 8, 2023
1 parent 576a6b8 commit b387cff
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 3 deletions.
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,21 @@
Process Compose is a simple and flexible scheduler and orchestrator to manage non-containerized applications.

**Why?** Because sometimes you just don't want to deal with docker files, volume definitions, networks and docker registries.
Since it's written in Go, Process Compose is a single binary file and has no other dependencies.

Once [installed](https://f1bonacc1.github.io/process-compose/installation/), you just need to describe your workflow using a simple [YAML](http://yaml.org/) schema in a file called `porcess-compose.yaml`:

```yaml
version: "0.5"

processes:
hello:
command: echo 'Hello World from Process Compose'
```

And start it by running `process-compose` from your terminal.

Check the [Documentation](https://f1bonacc1.github.io/process-compose/launcher/) for more advanced use cases.

#### Features:

Expand All @@ -26,7 +41,7 @@ Process Compose is a simple and flexible scheduler and orchestrator to manage no
- Merge Configuration Files
- Namespaces
- Run Multiple Replicas of a Process
- Run Foreground Process
- Run a Foreground Process

It is heavily inspired by [docker-compose](https://github.com/docker/compose), but without the need for containers. The configuration syntax tries to follow the docker-compose specifications, with a few minor additions and lots of subtractions.

Expand All @@ -52,7 +67,7 @@ It is heavily inspired by [docker-compose](https://github.com/docker/compose), b

English is not my native language, so PRs correcting grammar or spelling are welcome and appreciated.

## Consider supporting the project ❤️
### Consider supporting the project ❤️

##### Github (preferred)

Expand All @@ -61,6 +76,7 @@ https://github.com/sponsors/F1bonacc1
##### Bitcoin

<img src="./imgs/btc.wallet.qr.png" style="zoom:80%;" alt="3QjRfBzwQASQfypATTwa6gxwUB65CX1jfX"/>

3QjRfBzwQASQfypATTwa6gxwUB65CX1jfX

Thank **You**!
17 changes: 16 additions & 1 deletion www/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,21 @@ Process Compose is a simple and flexible scheduler and orchestrator to manage no
## Why was it made?

Because sometimes you just don't want to deal with docker files, volume definitions, networks and docker registries.
Since it's written in Go, Process Compose is a single binary file and has no other dependencies.

Once [installed](installation.md), you just need to describe your workflow using a simple [YAML](http://yaml.org/) schema in a file called `porcess-compose.yaml`:

```yaml
version: "0.5"

processes:
hello:
command: echo 'Hello World from Process Compose'
```

And start it by running `process-compose up` from your terminal.

Check the [Documentation](launcher.md) for more advanced use cases.

<img src="https://github.com/F1bonacc1/process-compose/raw/main/imgs/tui.png" alt="TUI" style="zoom:67%;" />

Expand All @@ -27,4 +42,4 @@ Because sometimes you just don't want to deal with docker files, volume definiti
- Merge Configuration Files
- Namespaces
- Run Multiple Replicas of a Process
- Run Foreground Process
- Run a Foreground Process

0 comments on commit b387cff

Please sign in to comment.