Skip to content

Commit dfcda77

Browse files
committed
edit: readme install instructions
1 parent a4f1222 commit dfcda77

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,18 +74,21 @@ If multiple collections are passed, the above query is essentially replicated
7474
across all collections, see examples in 'tests/cols.ts'. In the future this
7575
will also accommodate multiple key searches.
7676
77+
78+
___
7779
## setup
7880
7981
1) running generated AQL queries will require a working arangodb instance.
8082
8183
## installation
8284
currently there is only support for server-side use.
8385
84-
1) clone this repository in your node compatible project.
85-
2) run `yarn add @hp4klh5/AQLqueryBuilder.js`
86+
1) clone this repository in your node compatible project.
87+
__or__
88+
run `yarn add @hp4klh5/AQLqueryBuilder.js`
8689
or `npm install --save @hp4klh5/AQLqueryBuilder.js`
8790
in a directory containing a `package.json` file.
88-
3) import/require the exported functions
91+
2) import/require the exported functions
8992
```js
9093
// use either
9194
import {buildAQL} from '@hp4klh5/AQLqueryBuilder.js'
@@ -193,6 +196,8 @@ ___
193196
}
194197
```
195198

199+
200+
___
196201
### boolean search logic
197202

198203
Quoting [mit's Database Search Tips](https://libguides.mit.edu/c.php?g=175963&p=1158594):
@@ -237,6 +242,7 @@ optional and is counted as an `OR`.
237242

238243
Please see [tests/parse.ts](tests/parse.ts) for more examples.
239244

245+
240246
#### Example
241247

242248
input `one +two -"buckle my shoe"` and `parseQuery()` will interpret that
@@ -270,6 +276,8 @@ only Document B is returned;
270276
Document A is excluded by the phrase "buckle my shoe"
271277
Document C does not contain the mandatory word "two"
272278

279+
280+
___
273281
## bugs
274282
plase see [bugs](https://github.com/HP4k1h5/AQLqueryBuilder.js/issues/new?assignees=HP4k1h5&labels=bug&template=bug_report.md&title=basic)
275283
## contributing

0 commit comments

Comments
 (0)