docs: add quick start example

Author: holvonixAdvay

README.md

@@ -19,7 +19,7 @@ import { Q } from 'solr-query-maker';
 
 // Returns the value of the `q` URL parameter for searching.
 function makeQuery() {
-  // '((geo:"Intersects(POINT (-122.17381 37.426002))" OR "spicy") OR title:He??o OR product:([100 TO *] AND (NOT 600)))'
+  // (geo:"Intersects(POINT(-122.17381 37.426002))" OR "spicy" OR title:He??o OR product:([100 TO *] AND (NOT 600)))
   return Q.toString(
     Q.or(
       Q.term(
@@ -35,6 +35,8 @@ function makeQuery() {
     )
   );
 }
+
+console.log(makeQuery());
 ```
 
 ## License

examples/.gitignore

@@ -0,0 +1,2 @@
+!node_modules/
+

examples/node_modules/solr-query-maker

@@ -0,0 +1,2 @@
+!node_modules/
+

examples/quickstart/.gitignore

@@ -0,0 +1,22 @@
+import { Q } from 'solr-query-maker';
+
+// Returns the value of the `q` URL parameter for searching.
+function makeQuery() {
+  // (geo:"Intersects(POINT(-122.17381 37.426002))" OR "spicy" OR title:He??o OR product:([100 TO *] AND (NOT 600)))
+  return Q.toString(
+    Q.or(
+      Q.term(
+        'geo',
+        Q.spatial.intersects({
+          type: 'Point',
+          coordinates: [-122.17381, 37.426002],
+        })
+      ),
+      Q.defaultTerm(Q.L('spicy')),
+      Q.term('title', Q.glob('He??o')),
+      Q.term('product', Q.and(Q.closedRange(100, undefined), Q.not(Q.L(600))))
+    )
+  );
+}
+
+console.log(makeQuery());

examples/quickstart/index.ts

@@ -0,0 +1 @@
+../../node_modules/

examples/quickstart/node_modules

@@ -0,0 +1,17 @@
+{
+  "name": "quickstart",
+  "version": "1.0.0",
+  "main": "index.ts",
+  "license": "Apache-2.0",
+  "private": true,
+  "scripts": {
+    "start": "ts-node index.ts"
+  },
+  "dependencies": {
+    "solr-query-maker": "../../"
+  },
+  "devDependencies": {
+    "ts-node": "^8.3.0",
+    "typescript": "^3.5.3"
+  }
+}

examples/quickstart/package.json

@@ -55,7 +55,7 @@
     "lint": "yarn fix && yarn run check",
     "check": "yarn run pretty.check && gts check",
     "fix": "yarn run pretty.fix && gts fix",
-    "test.examples": "echo 0",
+    "test.examples": "cd examples/quickstart && ts-node index.ts",
     "preversion": "yarn test && yarn test.examples",
     "docs": "yarn clean && yarn build && rm -rf docs && mkdir -p docs && ( mocha --grep='#private' --invert -R markdown >docs/index.md )",
     "test-unit": "yarn test --grep='#e2e|#int' --invert",