From db0e1e0d71f94363b97d3933f89e66c57c4e6f7d Mon Sep 17 00:00:00 2001 From: Vadim Markovtsev Date: Wed, 25 Oct 2017 11:11:14 +0200 Subject: [PATCH] Fix readme flaws Signed-off-by: Vadim Markovtsev --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8903731..da6b70d 100644 --- a/README.md +++ b/README.md @@ -19,11 +19,12 @@ 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 +### Faster regexp engine (optional) [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. +It is very fast and performs better than the one built into Go runtime. *enry* supports swapping +between those two engines thanks to [rubex](https://github.com/moovweb/rubex) project. +The typical overall speedup from using Onigumura is 1.5-2x. However, it requires CGo and the external shared library. On macOS with brew, it is ``` @@ -42,7 +43,7 @@ To build enry with Onigumura regexps, patch the imports with make onigumura ``` -nnd then rebuild the project. +and then rebuild the project. Examples ------------