Merge pull request #30 from getsafle/test

Readme Updates

Author: apoorvq

CHANGELOG.md

@@ -62,4 +62,9 @@
 
 ### 1.4.4 (2023-06-23)
 
-- update sign transaction to accept private key in case of imported wallet, null by default
+- update sign transaction to accept private key in case of imported wallet, null by default
+
+
+### 1.4.5 (2023-07-05)
+
+- Adding badges for Readme.md

README.md

@@ -1,6 +1,24 @@
-# Vault Eth Controller
+# Vault-eth-Controller<code><a href="https://www.docker.com/" target="_blank"><img height="50" src="https://assets.coingecko.com/coins/images/279/small/ethereum.png?1595348880"></a></code>
 
-## Install
+[![npm version](https://badge.fury.io/js/@getsafle%2Fvault-eth-controller.svg)](https://badge.fury.io/js/@getsafle%2Fvault-eth-controller)  <img alt="Static Badge" src="https://img.shields.io/badge/License-MIT-green">   [![Discussions][discussions-badge]][discussions-link]
+ <img alt="Static Badge" src="https://img.shields.io/badge/Eth_controller-documentation-purple">   
+
+A Module written in javascript for managing various keyrings of Ethereum accounts, encrypting them, and using them.
+
+- [Installation](#installation)
+- [Initialize the Eth Controller class](#initialize-the-eth-controller-class)
+- [Methods](#methods)
+  - [Generate Keyring with 1 account and encrypt](#generate-keyring-with-1-account-and-encrypt)
+  - [Restore a keyring with the first account using a mnemonic](#restore-a-keyring-with-the-first-account-using-a-mnemonic)
+  - [Add a new account to the keyring object](#add-a-new-account-to-the-keyring-object)
+  - [Export the private key of an address present in the keyring](#export-the-private-key-of-an-address-present-in-the-keyring)
+  - [Sign a transaction](#sign-a-transaction)
+  - [Sign a message](#sign-a-message)
+  - [Get balance](#get-balance)
+
+
+
+## Installation
 
 `npm install --save @getsafle/vault-eth-controller`
 
@@ -90,3 +108,5 @@ const receipt = await ethController.sendTransaction(signedTx, web3);
 ```
 const fees = await ethController.getFees(rawTx, web3);
 ```
+[discussions-badge]: https://img.shields.io/badge/Code_Quality-passing-rgba
+[discussions-link]: https://github.com/getsafle/vault-eth-controller/actions

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@getsafle/vault-eth-controller",
-  "version": "1.4.4",
+  "version": "1.4.5",
   "description": "Ethereum controller for safle vault.",
   "main": "src/index.js",
   "scripts": {