Skip to content

Commit

Permalink
Mention the convert-go command in the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
K-Phoen committed Dec 23, 2023
1 parent dc3167d commit da9d056
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,9 @@ creation of dashboards, this library is meant for you.
## Design goals

* provide an understandable abstraction over dashboards configuration
* expose a developer-friendly API
* allow IDE assistance and auto-completion
* expose a **developer-friendly API**
* allow IDE assistance and **auto-completion**
* **generate Go code** from existing dashboards

**Note**: Grafana 8+ is required, with [unified alerting](https://grafana.com/blog/2021/06/14/the-new-unified-alerting-system-for-grafana-everything-you-need-to-know/) enabled.

Expand Down Expand Up @@ -43,6 +44,9 @@ builder := dashboard.New(
)
```

> **Note**
> Existing dashboards can be converted to Go code using the `grabana convert-go` CLI command.
Dashboard creation:

```go
Expand Down

0 comments on commit da9d056

Please sign in to comment.