Skip to content

Commit 16cd9bb

Browse files
authored
Remove developer jargon from README (#30)
* Remove build instructions from README and update BUILD * Update README.md
1 parent d6dc310 commit 16cd9bb

File tree

2 files changed

+12
-42
lines changed

2 files changed

+12
-42
lines changed

BUILD.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -103,10 +103,6 @@ t=2020-07-01T06:03:38+0000 lvl=info msg="HTTP Server Listen" logger=http.server
103103

104104
- Add new Datasource to Grafana using `Configuration` -> `Data Sources`
105105

106-
![Datasource](https://github.com/RedisTimeSeries/grafana-redis-datasource/blob/master/images/datasource.png)
107-
108-
- Import Redis monitoring dashboard from `dashbords/` folder
109-
110-
![Dashboard](https://github.com/RedisTimeSeries/grafana-redis-datasource/blob/master/images/redis-dashboard.png)
106+
![Datasource](https://raw.githubusercontent.com/RedisTimeSeries/grafana-redis-datasource/master/src/img/datasource.png)
111107

112108
If you have questions, enhancement ideas or running into issues, please just open an issue on the repository: https://github.com/RedisTimeSeries/grafana-redis-datasource

README.md

Lines changed: 11 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -36,46 +36,21 @@ Only Grafana 7.0 and later with a new plugin platform supported.
3636

3737
Datasource can connect to any Redis database. No special configuration is required.
3838

39-
### Do you need to build the datasource?
40-
41-
Yes. We are planning to add the datasource to Grafana repository as soon as version 1.0.0 is released, then it can be installed using
42-
`grafana-cli` from registry. Please follow [**Build datasource**](#build-datasource).
43-
44-
## Getting Started
45-
4639
### Build datasource
4740

4841
To learn step by step how to build Redis Datasource from scratch and register in new or existing Grafana please take a look at [BUILD](https://github.com/RedisTimeSeries/grafana-redis-datasource/blob/master/BUILD.md) instructions.
4942

50-
#### React frontend
51-
52-
- Install frontend dependencies
53-
54-
```bash
55-
yarn install
56-
```
57-
58-
- Build frontend
59-
60-
```bash
61-
yarn build
62-
```
63-
64-
#### Golang backend
65-
66-
- Install [Grafana plugin SDK for Go](https://grafana.com/docs/grafana/latest/developers/plugins/backend/grafana-plugin-sdk-for-go/) dependency
43+
## Getting Started
6744

68-
```bash
69-
go get -u github.com/grafana/grafana-plugin-sdk-go
70-
```
45+
### Install using `grafana-cli`
7146

72-
- Build backend plugin binaries for Linux, Windows and MacOS
47+
Use the `grafana-cli` tool to install from the commandline:
7348

7449
```bash
75-
mage -v
50+
grafana-cli plugins install redis-datasource
7651
```
7752

78-
### Run using docker-compose
53+
### Run using `docker-compose`
7954

8055
Project provides `docker-compose.yml` to start Redis with RedisTimeSeries module and Grafana 7.0.
8156

@@ -85,9 +60,7 @@ Project provides `docker-compose.yml` to start Redis with RedisTimeSeries module
8560
docker-compose up
8661
```
8762

88-
Open Grafana in your browser [http://localhost:3000](http://localhost:3000) and configure datasource
89-
90-
You can add as many datasources as you want to support multiple Redis databases.
63+
Open Grafana in your browser [http://localhost:3000](http://localhost:3000) and configure datasource. You can add as many datasources as you want to support multiple Redis databases.
9164

9265
![Datasource](https://raw.githubusercontent.com/RedisTimeSeries/grafana-redis-datasource/master/src/img/datasource.png)
9366

@@ -140,14 +113,15 @@ We love to hear from users, developers and the whole community interested by thi
140113

141114
## Contributing
142115

143-
- Fork the repository
116+
- Fork the repository.
144117
- Find an issue to work on and submit a pull request
145-
- Pick a [good first issue](https://github.com/RedisTimeSeries/grafana-redis-datasource/labels/good%20first%20issue)
146-
- Could not find an issue? Look for documentation, bugs, typos, and missing features :)
118+
- Pick a [good first issue](https://github.com/RedisTimeSeries/grafana-redis-datasource/labels/good%20first%20issue).
119+
- Could not find an issue? Look for documentation, bugs, typos, and missing features.
147120

148121
## Other interesting resources
149122

150-
- [Redis TimeSeries](https://oss.redislabs.com/redistimeseries/)
123+
- [RedisTimeSeries](https://oss.redislabs.com/redistimeseries/)
124+
- [Redis Pop-up store](https://github.com/RedisTimeSeries/redis-pop-up-store)
151125

152126
## License
153127

0 commit comments

Comments
 (0)