Updated README [ci skip]

s9e · May 30, 2019 · f63fadf · f63fadf
1 parent 59d0167
commit f63fadf
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,4 +1,6 @@
-s9e\RegexpBuilder is a single-purpose library that generates regular expressions that match a list of strings.
+s9e\RegexpBuilder is a single-purpose library that generates a regular expression that matches a given list of strings.
+
+Simply put, given `['foo', 'bar', 'baz']` as input, the library will generate `/(?:ba[rz]|foo)/`.
 
 [![Build Status](https://api.travis-ci.org/s9e/RegexpBuilder.svg?branch=master)](https://travis-ci.org/s9e/RegexpBuilder)
 [![Code Coverage](https://scrutinizer-ci.com/g/s9e/RegexpBuilder/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/s9e/RegexpBuilder/?branch=master)