Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
wenn committed Nov 27, 2024
1 parent f8574cc commit 3939aae
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 10 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
[![Vet](https://github.com/reverbdotcom/sbx/actions/workflows/vet.yaml/badge.svg)](https://github.com/reverbdotcom/sbx/actions/workflows/vet.yaml)

# sbx
Orchestra CLI tool
Orchestra CLI tool - `sbx up`


## Installation
#### Install / Upgrade

```bash
go install github.com/reverbdotcom/sbx@latest
export GOPRIVATE=github.com/reverbdotcom && go install github.com/reverbdotcom/sbx@latest
```

## Development
#### Development

`sbx.go` is the main entry point for the CLI tool.
Every command should be a go package. Commands are
Expand All @@ -19,3 +19,6 @@ configured in `commands/commands.go`.

`make <command>.run` will build and run the command.
This runs live.

#### Test
`make test`
12 changes: 6 additions & 6 deletions name/name_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ import (
)

func TestRun(t *testing.T) {
dictionary = func() ([]string, error) {
return []string{"blake", "julian", "kevin"}, nil
}
dictionary = func() ([]string, error) {
return []string{"blake", "julian", "kevin"}, nil
}

t.Run("it generates a sandbox name", func(t *testing.T) {
branch = func() (string, error) {
Expand All @@ -28,9 +28,9 @@ func TestRun(t *testing.T) {
}

func TestProperNames(t *testing.T) {
dictionary = func() ([]string, error) {
return []string{"blake", "julian", "kevin", "a", "super-long-name-that-does-not-fit"}, nil
}
dictionary = func() ([]string, error) {
return []string{"blake", "julian", "kevin", "a", "super-long-name-that-does-not-fit"}, nil
}

t.Run("it should be longer than 2 and less than 13", func(t *testing.T) {
words, err := properNames()
Expand Down

0 comments on commit 3939aae

Please sign in to comment.