fix: readme changes

faablecloud · Sep 19, 2023 · 96df669 · 96df669
1 parent b3e54e6
commit 96df669
Showing 1 changed file with 15 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,7 @@
   <a href="https://faable.com">
     <h1 align="center">FaableQL</h1>
   </a>
+  <p align="center">A small domain specific language to create simple MongoDB queries</p>
 </p>
 
 <p align="center">
@@ -10,14 +11,26 @@
   </a>
 </p>
 
-A small domain specific language to create simple MongoDB queries.
-
 Syntax:
 
 ```
 <field1>:<value> <field2>:<value>
 ```
 
+## 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: