diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..d2c6796
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,76 @@
+# Human2Regex
+
+## Purpose
+
+Generate regular expressions from natural language. Currently WIP, but should look something like this:
+
+Instead of a convoluted mess of symbols why not
+
+ using global matching
+ create a group called "capture_me"
+ match 0+ words or "." or "=" or "-"
+ match 1+ words
+
+Running the program should result in the following output:
+
+ Your regex = /\$([\w\.=\-]*[\w]+)/g
+ "capture_me" is group id 1
+
+Is the former not much easier to read and bug fix than the latter?
+
+Another example
+
+ // H2R supports // # and /**/ as comments
+ // A group is only captured if given a name.
+ // You can use "and", "or", "not" to specify `[]` regex
+ // You can use "then" to combine match statements, however I find using multiple "match" statements easier to read
+
+ // exact matching means use a ^ and $ to signify the start and end of the string
+
+ using global and exact matching
+ create an optional group called "protocol"
+ match "http"
+ optionally match "s"
+ match "://"
+ create a group called "subdomain"
+ repeat
+ match 1+ words
+ match "."
+ create a group called "domain"
+ match 1+ words or "_" or "-"
+ match "."
+ match a word
+ # port, but we don't care about it, so ignore it
+ optionally match ":" then 0+ digits
+ create an optional group called "path"
+ repeat
+ match "/"
+ match 0+ words or "_" or "-"
+ create an optional group
+ # we don't want to capture the '?', so don't name the group until afterwards
+ match "?"
+ create a group called "query"
+ repeat
+ match 1+ words or "_" or "-"
+ match "="
+ match 1+ words or "_" or "-"
+ create an optional group
+ # fragment, again, we don't care, so ignore everything afterwards
+ match "#"
+ match 0+ anything
+
+Running the program should result in the following output:
+
+ Your regex = /^(https?:\/\/)?((\w\.)*)(:\d+)?([\w_\-]\.\w)((/[\w_\-]))?(\?([\w_\-]=[\w_\-]))?(#.*)$/g
+ "protocol" is group id 1
+ "subdomain" is group id 2
+ "domain" is group id 4
+ "path" is group id 5
+ "query" is group id 5 or 6 if "path" exists
+
+## Usage
+Configure config.ts
+Run
+
+ npm run build
+
diff --git a/build.ts b/build.ts
index 726d594..8ff19ff 100644
--- a/build.ts
+++ b/build.ts
@@ -5,7 +5,7 @@ import { readFileSync, copyFileSync, writeFileSync, existsSync, mkdirSync } from
import { emptyDirSync } from 'fs-extra';
import { minify } from 'html-minifier';
import { basename } from 'path';
-import { minify as uglify } from 'uglify-js';
+import { minify as uglify } from 'uglify-es';
import clean_css from 'clean-css';
import { glob } from 'glob';
import { config } from './config';
@@ -73,7 +73,7 @@ function build() {
const error_files = glob.sync(join(config.src, 'error', '*.json'));
// get partials
- let partials = {
+ const partials = {
header: read_file(join(config.src, '/header.mustache')),
footer: read_file(join(config.src, '/footer.mustache'))
};
diff --git a/docs/400.html b/docs/400.html
index 9816360..db1e89f 100644
--- a/docs/400.html
+++ b/docs/400.html
@@ -1 +1 @@
-Error 400 - Bad RequestSkip to main content
\ No newline at end of file
diff --git a/docs/401.html b/docs/401.html
index de1b1c1..98b4129 100644
--- a/docs/401.html
+++ b/docs/401.html
@@ -1 +1 @@
-Error 401 - UnauthorizedSkip to main content
\ No newline at end of file
diff --git a/docs/404.html b/docs/404.html
index a433ca9..de773ba 100644
--- a/docs/404.html
+++ b/docs/404.html
@@ -1 +1 @@
-Error 404 - Not FoundSkip to main content
\ No newline at end of file
diff --git a/docs/501.html b/docs/501.html
index 0f69fd9..de46433 100644
--- a/docs/501.html
+++ b/docs/501.html
@@ -1 +1 @@
-Error 501 - Not ImplementedSkip to main content
\ No newline at end of file
diff --git a/docs/index.html b/docs/index.html
index 11b83be..a6d9659 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -1 +1 @@
-Human2RegexSkip to main content