From bbd928aa51c2d2268a40e6f7532ccae17144dc88 Mon Sep 17 00:00:00 2001
From: Russell Anderson <5637107+rpanderson@users.noreply.github.com>
Date: Wed, 17 Jun 2020 11:39:17 +1000
Subject: [PATCH] Populated README.md with styling, iconogrpahy, prose, and
 badges

---
 README.md | 22 +++++++++++++++++-----
 1 file changed, 17 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 557a1b1..9963d95 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,21 @@
-# labscript_utils
+<img src="https://raw.githubusercontent.com/labscript-suite/labscript-suite/master/art/labscript_32nx32n.svg" height="64" alt="the labscript suite" align="right">
 
-Shared modules used by the labscript suite. Includes a graphical exception handler, debug tools, configuration management, cross platform filepath conversions, unit conversions and custom GUI widgets.
+# the _labscript suite_ » labscript-utils
 
-( 
-[view on Github](https://github.com/labscript-suite/labscript_utils)
-)
+### Shared modules used by the _labscript suite_
 
+[![Actions Status](https://github.com/labscript-suite/labscript-utils/workflows/Build%20and%20Release/badge.svg?branch=maintenance%2F3.0.x)](https://github.com/labscript-suite/labscript-utils/actions)
+[![License](https://img.shields.io/pypi/l/labscript-utils.svg)](https://github.com/labscript-suite/labscript-utils/raw/master/LICENSE.txt)
+[![Python Version](https://img.shields.io/pypi/pyversions/labscript-utils.svg)](https://python.org)
+[![PyPI](https://img.shields.io/pypi/v/labscript-utils.svg)](https://pypi.org/project/labscript-utils)
+[![Conda Version](https://img.shields.io/conda/v/labscript-suite/labscript-utils)](https://anaconda.org/labscript-suite/labscript-utils)
+[![Google Group](https://img.shields.io/badge/Google%20Group-labscriptsuite-blue.svg)](https://groups.google.com/forum/#!forum/labscriptsuite)
+<!-- [![DOI](http://img.shields.io/badge/DOI-10.1063%2F1.4817213-0F79D0.svg)](https://doi.org/10.1063/1.4817213) -->
 
+
+Shared modules used by the [*labscript suite*](https://github.com/labscript-suite/labscript-suite). Includes a graphical exception handler, debug tools, configuration management, cross-platform filepath conversions, physical unit conversions and custom GUI widgets.
+
+
+## Installation
+
+labscript-utils is distributed as a Python package on [PyPI](https://pypi.org/user/labscript-suite) and [Anaconda Cloud](https://anaconda.org/labscript-suite), and should be installed with other components of the _labscript suite_. Please see the [installation guide](https://docs.labscriptsuite.org/en/latest/installation) for details.