first commit

README.md

@@ -1 +1,19 @@
-# dsql
+# Datasquirel
+
+## Instalation
+
+### Package manager
+
+Using npm:
+
+```bash
+$ npm install datasquirel
+```
+
+Once the package is installed, you can import the library using `require` approach:
+
+```js
+const datasquirel = require("datasquirel");
+```
+
+## Usage

index.js

@@ -18,11 +18,11 @@ const get = require("./utils/get");
  * ==============================================================================
  * @param {Object} mailObject - foundUser if any
  */
-const dsql = {
+const datasquirel = {
     get: get,
 };
 
-module.exports = dsql;
+module.exports = datasquirel;
 
 /** ********************************************** */
 /** ********************************************** */

package.json

@@ -1,28 +1,28 @@
 {
-  "name": "dsql",
-  "version": "1.0.0",
-  "description": "Cloud-based SQL data management tool",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/BenjaminToby/dsql.git"
-  },
-  "keywords": [
-    "SQL",
-    "Cloud",
-    "Cloud",
-    "Storage",
-    "API",
-    "Data",
-    "Storage"
-  ],
-  "author": "Benjamin Toby",
-  "license": "ISC",
-  "bugs": {
-    "url": "https://github.com/BenjaminToby/dsql/issues"
-  },
-  "homepage": "https://github.com/BenjaminToby/dsql#readme"
+    "name": "datasquirel",
+    "version": "1.0.0",
+    "description": "Cloud-based SQL data management tool",
+    "main": "index.js",
+    "scripts": {
+        "test": "echo \"Error: no test specified\" && exit 1"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/BenjaminToby/dsql.git"
+    },
+    "keywords": [
+        "SQL",
+        "Cloud",
+        "Cloud",
+        "Storage",
+        "API",
+        "Data",
+        "Storage"
+    ],
+    "author": "Benjamin Toby",
+    "license": "ISC",
+    "bugs": {
+        "url": "https://github.com/BenjaminToby/dsql/issues"
+    },
+    "homepage": "https://github.com/BenjaminToby/dsql#readme"
 }