@cemiltokatli/node-data - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

package.json

 {
   "name": "@cemiltokatli/node-data",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Database helper library that provides classes and methods for you to query MySQL database.",
@@ -5,0 +5,0 @@ "keywords": ["database", "mysql", "node", "data", "sql", "query"],

README.md

@@ -146,3 +146,36 @@ # Node Data
 
+## Installation
+
+You can install `node-data` with the following `npm` command:
+
+```
+npm i @cemiltokatli/node-data
+```
+
 ## Usage
 
+### Creating a connection pool
+
+```
+import Database from '@cemiltokatli/node-data/Database'
+
+const database = new Database({
+    host: 'localhost',
+    port: 3306,
+    user: 'root',
+    password: 'root',
+    database: 'mydatabase',
+})
+```
+
+Then, you can retrieve a new database connection from the pool:
+
+```
+const connection = await database.getConnection()
+
+// database operations...
+
+connection.release()
+```
+
+Please check the [sample project](https://github.com/cemiltokatli/node-data-sample) folder for usage examples.

No alert changes

Improved metrics

Total package byte prevSize

26471

increased by2.49%

Number of lines in readme file

181

increased by22.3%

No dependency changes