Skip to content

Commit

Permalink
Improve readability README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
marcofranssen committed Jan 2, 2023
1 parent cdd373f commit 1055593
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ image: 'ubuntu@sha256:47f14534bda344d9fe6ffd6effb95eefe579f4be0d508b7445cf77f61a
**⚠️ Warning!** The README corresponds to the `main` branch of ratchet's
development, and it may contain unreleased features.

**Pin to specific versions:**
### Pin to specific versions

```shell
# pin the input file
Expand All @@ -75,7 +75,7 @@ development, and it may contain unreleased features.
./ratchet pin -out workflow-compiled.yml workflow.yml
```

**Unpin existing pinned versions:**
### Unpin existing pinned versions

```shell
# unpin the input file
Expand All @@ -85,7 +85,7 @@ development, and it may contain unreleased features.
./ratchet unpin -out workflow.yml workflow-compiled.yml
```

**Update all versions to the latest matching constraint:**
### Update all versions to the latest matching constraint

```shell
# update the input file
Expand All @@ -104,13 +104,13 @@ development, and it may contain unreleased features.
For more information, run a command with `-help` to use detailed usage
instructions.

**Check if all versions are pinned:**
### Check if all versions are pinned

```shell
./ratchet check workflow.yml
```

**In a CI/CD workflow:**
### In a CI/CD workflow

Ratchet is distributed as a very small container, so you can use it as a step
inside CI/CD jobs. Here is a GitHub Actions example:
Expand Down

0 comments on commit 1055593

Please sign in to comment.