Skip to content

Commit 9f67788

Browse files
doc: Readme updates
1 parent 52cfb1f commit 9f67788

File tree

2 files changed

+6
-7
lines changed

2 files changed

+6
-7
lines changed

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,14 @@ This is a [Grafana](https://grafana.com/grafana/) plugin that supports direct co
55
and supports standard Haystack API operations as well as custom Axon execution, which is supported by
66
[SkySpark](https://skyfoundry.com/product) and [Haxall](https://haxall.io/).
77

8+
You can find more information on the
9+
[Haystack Grafana Plugin Page](https://grafana.com/grafana/plugins/needleinajaystack-haystack-datasource/)
10+
811
![Dashboard Example](src/img/screenshot/dashboard.png)
912

1013
## Installation
1114

12-
Long term, the goal is to get this into the Grafana plugin repository. Until then, I must manually sign the plugin
13-
for your particular Grafana URL. If interested, please contact me at [email protected].
15+
This data source plugin may be installed within the Grafana "Connect data" UI on compliant versions.
1416

1517
## Usage
1618

@@ -22,7 +24,3 @@ the instructions in the [plugin readme](./src/README.md)
2224
Contributions are very welcome! For details on how to develop this plugin, see the
2325
[development guide](./DEVELOPMENT_GUIDE.md).
2426

25-
## Continuing Work
26-
27-
- [ ] Publish plugin
28-
- [ ] Consider enabling multi-point hisRead (through filters)

src/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ Haystack query that should be performed. The supported queries are:
2424

2525
- Eval: Evaluate a free-form Axon expression. _Note: Not all Haystack servers support this functionality_
2626
- HisRead: Display the history of a single point over the selected time range.
27-
- Read: Display the records matching a filter. Since this is not timeseries data, it can only be viewed in Grafana's
27+
- HisRead via filter: Read multiple points using a filter, and display their histories over the selected time range.
28+
- Read: Display the records matching a filter. Since this is not timeseries data, it is best viewed in Grafana's
2829
"Table" view.
2930

3031
#### Variable Usage

0 commit comments

Comments
 (0)