Skip to content

Commit

Permalink
docs(readme): updates readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
struckchure committed Aug 21, 2024
1 parent cab09ae commit 1924ba9
Showing 1 changed file with 7 additions and 15 deletions.
22 changes: 7 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ Storm is an automation agent that helps to run workflows on remote or local mach

# Installation

For use in golang

```sh
go get https://github.com/overal-x/formatio.storm
```

For Linux and MacOS

```sh
Expand Down Expand Up @@ -35,24 +41,10 @@ Run worklow on current host
storm run ./samples/basic/workflow.yaml
```

# Features

- [x] Read YAML configuration similar to GitHub workflow
- [x] CLI to send workflow to machines
- [x] Agent to execute workflows
- [x] Machine inventory
- [ ] Execute commands as sudo user
- [ ] Provide inventory to store sudo user password
- [ ] Provide inventory to store ssh user password

# Bug

- [x] Execute workflow jobs in the order they appear

# Development

```sh
git clone git@github.com:Overal-X/formatio.storm.git
go mod tidy
go build -o storm
go run ./cmd help
```

0 comments on commit 1924ba9

Please sign in to comment.