docs: more docs

Author: gruhn

README.md

@@ -24,8 +24,8 @@ npm install @gruhn/regex-utils
 
 There is a high-level API and a low-level API:
 
- - [high-level API documentation](https://gruhn.github.io/regex-utils/modules/high-level-api.html)
- - [low-level API documentation](https://gruhn.github.io/regex-utils/modules/low-level-api.html)
+ - [high-level API documentation](https://gruhn.github.io/regex-utils/modules/High-level_API.html)
+ - [low-level API documentation](https://gruhn.github.io/regex-utils/modules/Low-Level_API.html)
 
 The high-level API operates directly on native JavaScript `RegExp` instances,
 which is more convenient but also requires parsing the regular expression.

package.json

@@ -1,5 +1,9 @@
 {
   "name": "@gruhn/regex-utils",
+  "description": "TypeScript library for regex intersection, complement and other utilities that go beyond string matching.",
+  "author": "Niklas Gruhn",
+  "license": "MIT",
+  "repository": "github:gruhn/regex-utils",
   "version": "0.0.0-development",
   "type": "module",
   "scripts": {
@@ -8,24 +12,20 @@
     "build": "tsc --project tsconfig.build.json && tsc-alias",
     "build:docs": "typedoc --tsconfig tsconfig.build.json"
   },
-  "main": "./dist/high-level-api.js",
+  "main": "./dist/index.js",
   "exports": {
     ".": {
-      "import": "./dist/high-level-api.js",
-      "types": "./dist/high-level-api.d.ts"
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
     },
     "./low-level-api": {
       "import": "./dist/low-level-api.js",
       "types": "./dist/low-level-api.d.ts"
     }
   },
-  "author": "Niklas Gruhn",
-  "license": "MIT",
-  "repository": "github:gruhn/regex-utils",
   "files": [
     "dist"
   ],
-  "description": "TypeScript library for regex intersection, complement and other utilities that go beyond string matching.",
   "devDependencies": {
     "0x": "^5.8.0",
     "fast-check": "^3.23.2",

src/high-level-api.ts src/index.tssrc/high-level-api.ts renamed to src/index.ts

@@ -1,3 +1,10 @@
+/**
+ * The high-level API operates directly on native JavaScript `RegExp` instances.
+ * Use this if you want convenience. Use the low-level API if you want speed.
+ * 
+ * @module High-level API
+ */
+
 import * as RE from './low-level-api'
 
 /**

src/low-level-api.ts

@@ -1,3 +1,20 @@
+/**
+ * The high-level API operates directly on native JavaScript `RegExp` instances.
+ * The low-level API provides the same functions but operates on the custom data
+ * types `StdRegex` (standard regex) and `ExtRegex` (extended regex).
+ * Most of the additional functions are just a
+ * [DSL](https://en.wikipedia.org/wiki/Domain-specific_language)
+ * for constructing instances of these types.
+ * 
+ * `ExtRegex` is a super-type of `StdRegex` and extends it with complement and 
+ * intersection operators which have no direct representation in standard regular 
+ * expressions. Some operations like `size` and `enumerate` only work on `StdRegex`.
+ * `ExtRegex` can always be "compiled down" to `StdRegex` using `toStdRegex`.
+ * But note that most computational cost is concentrated in this transformation.
+ *
+ * @module Low-Level API
+ */
+
 export {
   parseRegExp as parse
 } from './regex-parser'

typedoc.json

@@ -1,5 +1,4 @@
 {
-  "entryPoints": ["src/high-level-api.ts", "src/low-level-api.ts"],
   "navigationLinks": {
     "GitHub": "https://github.com/gruhn/regex-utils"
   }