Merge pull request #5 from factrylabs/publication

Prep for Grafana.net publication

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright {yyyy} {name of copyright owner}
+   Copyright 2020 Factry BV, Heidestraat 1, BE-9688
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -1,5 +1,7 @@
 # Untimely
 
+![Untimely Grafana Panel Screenshot](https://www.factry.io/blog/introducing-untimely-grafana-panel/panel.png "Untimely Grafana Panel Screenshot")
+
 ## Introduction
 The Untimely Grafana plugin is a panel that facilitates working with distances on the x-axis (or anything else that isn't time).
 
@@ -15,6 +17,18 @@ It's based on the Grafana React example using Typescript.
 - Tooltip: the panel has a simple tooltip, supporting multiple series, similar to the default Grafana tooltip
 - Offset: when the x-values have a certain offset, you can define this
 
+## Installation
+To install the plugin:
+
+- First build the plugin (`yarn build`)
+- Rename the `dist/` folder to a nicer name, identifying it in the plugin directory
+- Copy that directory to `/var/lib/grafana/plugins` in your Grafana installation
+- Restart the grafana server (`sudo systemctl restart grafana-server`)
+
+## Usage and tips
+- Use the decimal formatting to choose how many decimals should be in the ticks and on the tooltip
+- When you have resets, choose the 'max' selector for your x-axis series and the 'min' selector for the other series
+- A little downwards arrow next to a value denotes that there is a reset
 
 ## Development
 Make **sure** you are running Node 12
@@ -41,16 +55,3 @@ To build the plugin run:
 ```
 yarn build
 ```
-
-## Installation
-To install the plugin:
-
-- First build the plugin (`yarn build`)
-- Rename the `dist/` folder to a nicer name, identifying it in the plugin directory
-- Copy that directory to `/var/lib/grafana/plugins` in your Grafana installation
-- Restart the grafana server (`sudo systemctl restart grafana-server`)
-
-## Usage and tips
-- Use the decimal formatting to choose how many decimals should be in the ticks and on the tooltip
-- When you have resets, choose the 'max' selector for your x-axis series and the 'min' selector for the other series
-- A little downwards arrow next to a value denotes that there is a reset

package.json

@@ -1,14 +1,14 @@
 {
   "name": "@factry/untimely-panel",
-  "version": "1.0.0",
-  "description": "Untimely",
+  "version": "0.1.0",
+  "description": "Untimely Grafana panel",
   "scripts": {
     "build": "grafana-toolkit plugin:build",
     "test": "grafana-toolkit plugin:test --coverage",
     "dev": "grafana-toolkit plugin:dev",
     "watch": "grafana-toolkit plugin:dev --watch"
   },
-  "author": "Factry",
+  "author": "Factry BV",
   "license": "Apache-2.0",
   "devDependencies": {
     "@grafana/data": "next",

src/plugin.json

@@ -1,21 +1,22 @@
 {
   "type": "panel",
   "name": "Untimely",
-  "id": "untimely-factryio",
+  "id": "factrylabs-untimely-panel",
 
   "info": {
-    "description": "Untimely panel by Factry",
+    "description": "Grafana panel for displaying time series data as function of distance",
     "author": {
-      "name": "Factry"
+      "name": "Factry",
+      "url": "https://www.factry.io"
     },
-    "keywords": ["Untimely", "Panel", "Grafana", "Factry", "Graph"],
+    "keywords": ["untimely", "panel", "distance", "length", "industry"],
     "logos": {
       "small": "img/logo.png",
       "large": "img/logo.png"
     },
     "links": [
       {"name": "Website", "url": "https://www.factry.io"},
-      {"name": "License", "url": "https://github.com/grafana/simple-react-panel/blob/master/LICENSE"}
+      {"name": "License", "url": "https://github.com/factrylabs/untimely-grafana-panel/blob/master/LICENSE"}
     ],
     "screenshots": [],
     "version": "%VERSION%",