From 52ab47de4dc62727ceecf4f75c4413e1f8fe31e0 Mon Sep 17 00:00:00 2001 From: Vadim Markovtsev Date: Fri, 29 Sep 2017 14:58:24 +0200 Subject: [PATCH] Add the readme Signed-off-by: Vadim Markovtsev --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index ef38305..8903731 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,31 @@ To build enry's CLI you must run this will generate a binary in the project's root directory called `enry`. You can then move this binary to anywhere in your `PATH`. +### Faster regexp engine + +[Onigumura](https://github.com/kkos/oniguruma) is CRuby's regular expression engine. +It is very fast and performs better than the one built into Go runtime. +The typical overall speedup is 1.5-2x. However, it requires CGo and the external shared library. +On macOS with brew, it is + +``` +brew install onigumura +``` + +On Ubuntu, it is + +``` +sudo apt install libonig-dev +``` + +To build enry with Onigumura regexps, patch the imports with + +``` +make onigumura +``` + +nnd then rebuild the project. + Examples ------------