edit: README fixes

Author: hp4k1h5

CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+- v0.1.2
+  - 📓 Updated docs to properly reflect key names. Prior versions of this
+      README were not up to date with the current functionality. Package
+      functionality remains the same. Current and more accurate
+      documentation can be generated by running `yarn doc && serve docs/`.
+
 - v0.1.1
   - ❌ Breaking change!  
       `buildAQL()`'s `limit` parameter no longer accepts key

README.md

@@ -23,6 +23,11 @@ interface](./img/searchbar_demo.png)
 - [contributing](#contributing)
 
 ## Patch Notes
+- v0.1.2
+  - 📓 Updated docs to properly reflect key names. Prior versions of this
+      README were not up to date with the current functionality. Package
+      functionality remains the same. Current and more accurate
+      documentation can be generated by running `yarn doc && serve docs/`.
 
 - v0.1.1
   - ❌ Breaking change!  
@@ -168,7 +173,7 @@ const queryObject = {
     "analyzer": "analyzer_name",
     "keys": ["text"]
   }],
-  "query": "+'query string' -for +parseQuery ?to parse"
+  "terms": "+'query string' -for +parseQuery ?to parse"
 }
 
 const limit = {start:0, count: 20}
@@ -208,8 +213,8 @@ indexed by the analyzer. If a collection is indexed by multiple analyzers
 please list each collection-analyzer combination along with their relevant
 keys, unless a unified set of keys is provided to `query.key`.
 
-• **query** (required): either an array of `term` interfaces or a query string
-to be parsed by `parseQuery`.
+• **terms** (required): either an array of `term` interfaces or a query string
+to be parsed by `parseQuery()`.
 - **term** (optional): a JSON object representing the search.
   - **val** *string* (required): a search term or phrase. For PHRASE
   searches, include one "quoted phrase" per val. For TOKENS you may combine
@@ -265,8 +270,8 @@ and the next page would be
       "keys": ["texto", "resumen", "notas"]
     }
   ],
-  "query": "either a +query ?\"string for parseQuery to parse\"    texto en español",
-  "query": [
+  "terms": "either a +query ?\"string for parseQuery to parse\"    texto en español",
+  "terms": [
            {"type": "phr", "op": "?", "val": "\"!!! OR a list of query objects\""},
            {"type": "phr", "op": "?", "val": "optional phrases"},
            {"type": "tok", "op": "-", "val": "excluded tokens"},

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hp4k1h5/aqlquerybuilder.js",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "license": "MIT",
   "main": "built/index.js",
   "types": "built/index.d.ts",

src/lib/structs.ts

@@ -31,8 +31,9 @@ export interface query {
  * include in the query must be listed as a collection of the following shape.
  *
  * A collection can be referenced by several analyzers and each must have its
- * own entry in `query.collections` in order to be included in the search.
- * Also, if query.key
+ * own entry in `query.collections` in order to be included in the search. If
+ * a collection does not have a `keys` key, the search will be performed
+ * across ALL keys listed in `query.key`.
  *
  * Alternatively, a document can be stored in several collections.
  *
@@ -62,6 +63,8 @@ export interface collection {
  *  **types**  | PHRASE |  ✅  | ✅  |  ✅   |
  *             | TOKENS |  ✅  | ✅  |  ✅   |
  *             | PROXIM | TODO | TODO| TODO  |
+ *             | NGRAM  | TODO | TODO| TODO  |
+ *             | LEVENS | TODO | TODO| TODO  |
  * ```
  * */
 export interface term {