Add readme

bboreham · bboreham · commit 769425be6f1a · 2021-12-21T18:07:14.000Z
diff --git a/README.md b/README.md
@@ -1,2 +1,9 @@
-# regexp
-Faster version of the Go regexp package
+# Grafana Go regexp package
+This repo is a fork of the upstream Go `regexp` package, with some code optimisations to make it run faster.
+
+All the optimisations have been submitted upstream, but not yet merged.
+
+All semantics are the same, and the optimised code passes all tests from upstream.
+
+The `main` branch is non-optimised: switch over to `speedup` branch to see the improvements.
+
