diff --git a/README.md b/README.md index 56128f6..20e3c54 100644 --- a/README.md +++ b/README.md @@ -1 +1,19 @@ -# dsql \ No newline at end of file +# 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 diff --git a/index.js b/index.js index 81e2f7e..d7bac8e 100644 --- a/index.js +++ b/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; /** ********************************************** */ /** ********************************************** */ diff --git a/package.json b/package.json index 210d473..07eb308 100644 --- a/package.json +++ b/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" }