Skip to content

Commit fa846e3

Browse files
committed
edit: readme typo!
1 parent 2455265 commit fa846e3

File tree

2 files changed

+13
-6
lines changed

2 files changed

+13
-6
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,14 @@
11
# AQLqueryBuilder.js
22
> a typescript query builder for [arangodb](https://www.arangodb.com)'s [ArangoSearch](https://www.arangodb.com/docs/stable/arangosearch.html)
3+
See working demo at [hp4k1h5.github.io](https://hp4k1h5.github.io/#search-box).
4+
5+
**!Note** AQLqueryBuilder.js does NOT contain any code for the search bar, only the
6+
query string parser and AQL builder. Unabstracted code for the searchbar is
7+
located
8+
[here](https://github.com/HP4k1h5/hp4k1h5.github.io/tree/main/demos/src/components/search).
9+
![search bar demonstration with schematic query
10+
interface](./img/searchbar_demo.png)
311

4-
##### ! pre-alpha (v0.0.X)
512
- [ overview ](#overview)
613
- [ setup](#setup)
714
- [ installation](#installation)
@@ -85,18 +92,18 @@ ___
8592
## installation
8693
currently there is only support for server-side use.
8794
88-
1) run `yarn add @hp4klh5/AQLqueryBuilder.js`
89-
or `npm install --save @hp4klh5/AQLqueryBuilder.js`
95+
1) run `yarn add @hp4k1h5/AQLqueryBuilder.js`
96+
or `npm install --save @hp4k1h5/AQLqueryBuilder.js`
9097
in a directory containing a `package.json` file.
9198
__or__
9299
clone this repository in your node compatible project.
93100
94101
2) import/require the exported functions
95102
```js
96103
// use either
97-
import {buildAQL} from '@hp4klh5/AQLqueryBuilder.js'
104+
import {buildAQL, parseQuery} from '@hp4k1h5/AQLqueryBuilder.js'
98105
// or
99-
const {buildAQL} = require('@hp4klh5/AQLqueryBuilder.js')
106+
const {buildAQL} = require('@hp4k1h5/AQLqueryBuilder.js')
100107
```
101108
This has been tested for
102109
- ✅ node v14.4.0
@@ -130,7 +137,7 @@ run against any number of language-specific collections simultaneously.
130137

131138
__Example:__
132139
```javascript
133-
import {buildAQL} from '@hp4klh5/AQLqueryBuilder.js'
140+
import {buildAQL} from '@hp4k1h5/AQLqueryBuilder.js'
134141

135142
const queryObject = {
136143
"view": "the_arango-search_view-name",

img/searchbar_demo.png

327 KB
Loading

0 commit comments

Comments
 (0)