Skip to content

Commit

Permalink
Merge pull request #24 from grafana/update-readme
Browse files Browse the repository at this point in the history
Add experimental notice and update npm tag
  • Loading branch information
csmarchbanks authored Sep 1, 2023
2 parents 4714b93 + 9266be2 commit 6a52fc6
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# Grafana LLM app
# Grafana LLM App (Experimental)

A Grafana plugin designed to centralise access to LLMs, providing authentication, rate limiting, and more.
Installing this plugin will enable various pieces of LLM-based functionality throughout Grafana.

Note: This plugin is **experimental**, and may change significantly between
versions, or deprecated completely in favor of a different approach based on
user feedback.

## Installing this plugin

To install this plugin, use the `GF_INSTALL_PLUGINS` environment variable when running Grafana:
Expand Down Expand Up @@ -46,13 +50,11 @@ First, add the correct version of `@grafana/experimental` to your dependencies i
```json
{
"dependencies": {
"@grafana/experimental": "grafana/grafana-experimental#44c73c843136cea876b620c127d6d5c76bdcde59"
"@grafana/experimental": "1.7.0"
}
}
```

(note we use a git commit hash for now until https://github.com/grafana/grafana-experimental/pull/72 is merged and released).

Then in your components you can use the `llm` object from `@grafana/experimental` like so:

```typescript
Expand Down

0 comments on commit 6a52fc6

Please sign in to comment.