From a5cb8b3d73da40e37c577f8cb8a641b2d373b295 Mon Sep 17 00:00:00 2001
From: Arisna <arisna@cakeplabs.com>
Date: Sat, 14 Jan 2023 00:26:21 +0800
Subject: [PATCH] add README

---
 README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a55a9c6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# AWS SDK for JavaScript
+
+## How To Install
+
+The preferred way to install the `jshashmap` for Node.js is to use the
+[npm](http://npmjs.org) package manager for Node.js. Simply type the following into a terminal:
+
+```sh
+npm install jshashmap
+```
+
+## Examples of Use
+
+Version 1 only support 1 function that convert Javascript object into Javascript `Map` class
+
+```javascript
+const jshashmap = require("jshashmap");
+
+const foodStocks = {
+  apple: 12,
+  bread: 20,
+  meat: 2,
+  vegetable: 35,
+};
+const hashmap = jshashmap.objToMap(foodStocks);
+console.log(hashmap);
+// Output:
+// Map(4) { 'apple' => 12, 'bread' => 20, 'meat' => 2, 'vegetable' => 35 }
+```