diff --git a/README.md b/README.md index 5aa91d3..77b6bdb 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@

FaableQL

+

A small domain specific language to create simple MongoDB queries

@@ -10,14 +11,26 @@

-A small domain specific language to create simple MongoDB queries. - Syntax: ``` : : ``` +## Install + +With NPM: + +```bash + npm install @faable/faableql +``` + +With Yarn: + +```bash + yarn add @faable/faableql +``` + ## Getting Started Configure fields that can be queried in MongoDB: