Update readme and docs (#58)

Author: marefr

README.md

@@ -1,5 +1,3 @@
-# Grafana Image Renderer [![CircleCI](https://circleci.com/gh/grafana/grafana-image-renderer.svg?style=svg)](https://circleci.com/gh/grafana/grafana-image-renderer)
-
 A Grafana backend plugin that handles rendering panels and dashboards to PNGs using headless Chrome.
 
 ## Requirements
@@ -10,44 +8,43 @@ A Grafana backend plugin that handles rendering panels and dashboards to PNGs us
 - Windows (x64)
 - Mac OS X (x64)
 
-### No dependencies
+### Dependencies
+
+This plugin is packaged in a single executable with [Node.js](https://nodejs.org/) runtime and [Chromium browser](https://www.chromium.org/Home).
+This means that you don't need to have Node.js and Chromium installed in your system for the plugin to function.
 
-This plugin is packaged in a single executable with [Node.js](https://nodejs.org/) runtime and [Chromium](https://www.chromium.org/Home). It does not require any additional software to be installed on the Grafana server.
+However, [Chromium browser](https://www.chromium.org/) depends on certain libraries and if you don't have all of those libraries installed in your
+system you may encounter errors when trying to render an image. For further details and troubleshooting help, please refer to
+[Grafana Image Rendering documentation](https://grafana.com/docs/administration/image_rendering/).
 
 ## Installation
 
 ### Using grafana-cli
 
 **NOTE:** Installing this plugin using grafana-cli is supported from Grafana v6.4.
 
-```
+```bash
 grafana-cli plugins install grafana-image-renderer
 ```
 
-### Clone into plugins folder
-
-1. Git clone this repo into the Grafana external plugins folder.
-2. Install dependencies and build.
+### Install in Grafana Docker image
 
-    ```
-    yarn install --pure-lockfile
-    yarn run build
-    ```
+This plugin is not compatible with the current Grafana Docker image without installing further system-level dependencies. We recommend setting up another Docker container
+for rendering and using remote rendering, see [Remote Rendering Using Docker](#remote-rendering-using-docker) for reference.
 
-3. Restart Grafana.
+If you still want to install the plugin in the Grafana docker image we provide instructions for how to build a custom Grafana image, see [Grafana Docker documentation](https://grafana.com/docs/installation/docker/#custom-image-with-grafana-image-renderer-plugin-pre-installed) for further instructions.
 
 ## Remote Rendering Using Docker
 
 Instead of installing and running the image renderer as a plugin, you can run it as a remote image rendering service using Docker. Read more about [remote rendering using Docker](https://github.com/grafana/grafana-image-renderer/blob/master/docs/remote_rendering_using_docker.md).
 
 ## Troubleshooting
 
-To get more logging information, update the Grafana configuration:
+For troubleshooting help, please refer to [Grafana Image Rendering documentation](https://grafana.com/docs/administration/image_rendering/#troubleshooting).
 
-```
-[log]
-filters = rendering:debug
-```
+## Building from source
+
+See [Building from source](https://github.com/grafana/grafana-image-renderer/blob/master/docs/building_from_source.md).
 
 ## Additional information
 

docs/building_from_source.md

@@ -0,0 +1,52 @@
+# Building from source
+
+Git clone this repo:
+
+```bash
+git clone https://github.com/grafana/grafana-image-renderer.git
+cd grafana-image-renderer
+```
+
+## Plugin
+
+1. Install [Node.js](https://nodejs.org/) and [Yarn](https://yarnpkg.com/en/).
+2. Install dependencies and build:
+
+    ```bash
+    make deps
+
+    # build and package for Linux x64
+    make build_package ARCH=linux-x64-glibc
+
+    # build and package for Window x64
+    make build_package ARCH=win32-x64-unknown
+
+    # build and package for Darwin x64
+    make build_package ARCH=darwin-x64-unknown
+
+    # build and package without including Chromium
+    make build_package ARCH=<ARCH> SKIP_CHROMIUM=true OUT=plugin-<ARCH>-no-chromium
+    ```
+
+3. Built artifacts can be found in ./artifacts directory
+
+## Docker image
+
+1. Install Docker
+2. Build Docker image:
+
+    ```bash
+    docker build -t custom-grafana-image-renderer .
+    ```
+
+## Local Node.js application using local Chrome/Chromium
+
+1. Install [Node.js](https://nodejs.org/) and [Yarn](https://yarnpkg.com/en/).
+2. Install dependencies and build:
+
+    ```bash
+    make deps
+    make build
+    ```
+
+3. Built artifacts are found in ./build

docs/index.md

@@ -1,5 +1,6 @@
 # Documentation
 
 - [Remote rendering using docker](remote_rendering_using_docker.md)
+- [Building from source](building_from_source.md)
 - [Package plugin as a single executable](package_plugin_as_single_executable.md)
 - [Release and publish a new version](release_new_version.md)