From 7254d74758008bae1736f93a0afa7e64c6ba1860 Mon Sep 17 00:00:00 2001
From: Seth <hullogh@gmail.com>
Date: Thu, 11 May 2023 14:11:51 +0800
Subject: [PATCH] docs: update readme with details

---
 README.md | 45 +++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 41 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 36a2324..2be921c 100644
--- a/README.md
+++ b/README.md
@@ -22,7 +22,44 @@ time-lock vault functionality such as `deposit`, `withdraw` and `batchWithdraw`.
 ## Custom Vaults
 
 Alternatively, you can create your own Solidity vault contract by extending the `TimeLockVault`
-abstract contract and implementing your desired logic. Your contract can inherit additional
-functionalities such as premature withdrawal (refer to the `_prematureWithdraw` function) before the
-maturity date subject your specific condition, control over the depositor/recipient addresses, and
-other aspects.
+abstract contract and implementing your desired logic.
+
+### Installation
+
+```bash
+npm install @superical/time-lock-vault --save-dev
+```
+
+### Usage
+
+Note that the `TimeLockVault` is an upgradeable contract. If you don't plan on upgrading your vault
+contract, you should initialise it in your constructor.
+
+```solidity
+import "@superical/time-lock-vault/contracts/TimeLockVault.sol";
+
+contract MyCustomVault is TimeLockVault {
+  constructor(string memory _name, string memory _symbol, address _asset) initializer {
+    // Initialize the TimeLockVault contract
+    __TimeLockVault_init(_name, _symbol, _asset);
+  }
+
+  // Implement custom deposit logic
+  function deposit(uint256 amount) external {
+    // Custom deposit condition here...
+    // Deposit from the sender to himself and to be locked for 1 day
+    _deposit(_msgSender(), _msgSender(), amount, 86400);
+  }
+
+  // Implement custom withdraw logic
+  function withdraw(uint256 depositId) external {
+    // Custom withdrawal condition here...
+    // Withdraw deposit ID to sender
+    _withdraw(depositId);
+  }
+}
+```
+
+Your contract will inherit additional functionalities such as premature withdrawal (refer to the
+`_prematureWithdraw` function) before the maturity date subject your specific condition, control
+over the depositor/recipient addresses, and other aspects.