Skip to content

Commit

Permalink
updates docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Shubhang Balkundi committed Apr 4, 2024
1 parent 37f9b68 commit 6dfe5c4
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ go install github.com/gojekfarm/ziggurat/v2/cmd/ziggurat@latest
```

### Using with an existing application

```shell
go get github.com/gojekfarm/ziggurat/v2
```
Expand All @@ -51,6 +52,33 @@ go get github.com/gojekfarm/ziggurat/v2
ziggurat new <app_name>
go mod tidy -v # cleans up dependencies
```
### Building from source

```shell
make lib.build
```

### Running unit tests

```shell
make lib.test
```

### Running integration tests

```shell
make lib.test-integration
```

### Coverage Report in HTML

```shell
lib.test-coverage-html
```

> [!NOTE]
> For other make tests refer to the Makefile

## Features

Expand Down

0 comments on commit 6dfe5c4

Please sign in to comment.