Skip to content

Commit 0b2c37b

Browse files
Merge pull request #54 from grafana/malcolmholmes/sammyj-readme-comments
Readme tweaks
2 parents ad66a61 + 66bcc0d commit 0b2c37b

File tree

2 files changed

+12
-8
lines changed

2 files changed

+12
-8
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,17 @@ This extension gives you support for Git (and any other version control system f
3434
1. Select the Extensions icon (![extensions icon](./public/extensions-icon.png)) on the left bar in VSCode.
3535
2. Enter `Grafana` into the search box. Select the option for `Grafana / Grafana Editor` and click `Install`.
3636
3. Open the Settings tab inside the extension (CTRL+, (comma) or `cmd` + `,` on Mac) and search for `grafana`. Then select `Extensions`.
37-
4. Provide the default URL for your Grafana instance in the `URL` field. If you are using a local Grafana instance, the default value is `http://localhost:3000`.
38-
5. Create a [Service account in Grafana](https://grafana.com/docs/grafana/latest/administration/service-accounts/#create-a-service-account-in-grafana) and add a token to it.
39-
6. In the VS Code settings, click `Set your token, securely` then paste your token into the popup. Press ENTER.
40-
7. Open a folder on your computer that has some dashboard JSON (if you don't have any of your own, navigate to the `dashboards` folder of this repo).
41-
8. Right-click on a dashboard JSON file and select `Edit in Grafana`.
42-
9. Have fun!
43-
10. Note, clicking `save` on your dashboard will update the JSON file in your local folder.
37+
38+
### Configure the Extension
39+
1. Provide the default URL for your Grafana instance in the `URL` field. If you are using a local Grafana instance, the default value is `http://localhost:3000`.
40+
2. Create a [Service account in Grafana](https://grafana.com/docs/grafana/latest/administration/service-accounts/#create-a-service-account-in-grafana) and add a token to it.
41+
3. In the VS Code settings, click `Set your token, securely` then paste your token into the popup. Press ENTER.
42+
43+
### Using the Extension
44+
1. Open a folder on your computer that has some dashboard JSON (if you don't have any of your own, navigate to the `dashboards` folder of [this repo](https://github.com/grafana/grafana-vs-code-extension/tree/main/dashboards)).
45+
2. Right-click on a dashboard JSON file in the file explorer and select `Edit in Grafana`.
46+
3. Have fun!
47+
4. Note, clicking `save` on your dashboard will update the JSON file in your local folder.
4448

4549
### Run from Repository
4650
1. If using local Grafana, start Grafana locally or via Docker.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"displayName": "Grafana",
55
"description": "Grafana Editor",
66
"icon": "public/grafana_icon.png",
7-
"version": "0.0.9",
7+
"version": "0.0.10",
88
"license": "Apache-2.0",
99
"repository": {
1010
"type": "git",

0 commit comments

Comments
 (0)