docs: add README.md (#1)

Initial draft of API instructions and usage.

.projenrc.js

@@ -6,6 +6,7 @@ const project = new ConstructLibraryCdk8s({
   defaultReleaseBranch: 'main',
   name: 'cdk8s-grafana',
   repositoryUrl: 'https://github.com/cdk8s-team/cdk8s-grafana.git',
+  constructsVersion: '3.3.48',
 
   // deps: [],                          /* Runtime dependencies of this module. */
   // description: undefined,            /* The description is just a string that helps people understand the purpose of the package. */

API.md

@@ -0,0 +1,28 @@
+# API Reference <a name="API Reference"></a>
+
+
+
+## Classes <a name="Classes"></a>
+
+### Hello <a name="cdk8s-grafana.Hello"></a>
+
+#### Initializer <a name="cdk8s-grafana.Hello.Initializer"></a>
+
+```typescript
+import { Hello } from 'cdk8s-grafana'
+
+new Hello()
+```
+
+#### Methods <a name="Methods"></a>
+
+##### `sayHello` <a name="cdk8s-grafana.Hello.sayHello"></a>
+
+```typescript
+public sayHello()
+```
+
+
+
+
+

README.md

@@ -1,15 +1,68 @@
-## My Project
+## cdk8s-grafana
 
-TODO: Fill this README out!
+cdk8s-grafana is a library that lets you easily define a Grafana service for
+your kubernetes cluster along with associated dashboards and datasources, using
+a high level API.
 
-Be sure to:
+### Usage
 
-* Change the title in this README
-* Edit your repository description on GitHub
+To apply the resources generated by this construct, the Grafana operator must be
+installed on your cluster. See
+<https://operatorhub.io/operator/grafana-operator> for full installation
+instructions.
+
+The following will define a Grafana cluster connected to a Prometheus
+datasource:
+
+```typescript
+import { Grafana } from 'cdk8s-grafana';
+
+// inside your chart:
+const grafana = new Grafana(this, 'my-grafana', {
+  defaultDataSource: {
+    name: 'Prometheus',
+    type: 'prometheus',
+    access: 'proxy',
+    url: 'http://prometheus-service:9090',
+  }
+});
+```
+
+Basic aspects of a dashboard can be customized:
+
+```typescript
+const github = grafana.addDatasource('github', ...);
+const dashboard = grafana.addDashboard('my-dashboard', { 
+  title: 'My Dashboard',
+  refreshRate: Duration.seconds(10),
+  timeRange: Duration.hours(6), // show metrics from now-6h to now
+  panels: [
+    {
+      "type": "text",
+      "title": "Panel Title",
+      "gridPos": {
+        "x": 0,
+        "y": 0,
+        "w": 12,
+        "h": 9
+      },
+      "mode": "markdown",
+      "content": "# title"
+    },
+  ],
+  plugins: [
+    {
+      name: 'grafana-piechart-panel',
+      version: '1.3.6',
+    }
+  ],
+});
+```
 
 ## Security
 
-See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
+See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more
+information.
 
 ## License