From beef01af416176b561316f4c68b980e176db4fbf Mon Sep 17 00:00:00 2001
From: jeremy-babylonlabs <jeremy.t@babylonlabs.io>
Date: Fri, 22 Nov 2024 15:36:41 +0800
Subject: [PATCH] update readme

---
 .changeset/fast-boxes-hope.md |  5 +++++
 README.md                     | 21 +++++++++++++++++++--
 2 files changed, 24 insertions(+), 2 deletions(-)
 create mode 100644 .changeset/fast-boxes-hope.md

diff --git a/.changeset/fast-boxes-hope.md b/.changeset/fast-boxes-hope.md
new file mode 100644
index 0000000..2302501
--- /dev/null
+++ b/.changeset/fast-boxes-hope.md
@@ -0,0 +1,5 @@
+---
+"@babylonlabs-io/bbn-core-ui": patch
+---
+
+update readme.MD
diff --git a/README.md b/README.md
index 3ec054a..b852e48 100644
--- a/README.md
+++ b/README.md
@@ -7,22 +7,39 @@
       <a href="https://www.npmjs.com/package/@babylonlabs-io/bbn-core-ui"><img src="https://badge.fury.io/js/@babylonlabs-io%2Fbbn-core-ui.svg" alt="npm version" height="18"></a>
     </p>
 </p>
-<br/>
+
+---
 
 ## Installation
 
+To install the package, run the following command:
+
 ```console
 npm i @babylonlabs-io/bbn-core-ui
 ```
 
 ## Version Release
 
-### Stable version
+### Stable Version
 
 Stable release versions are manually released from the main branch.
 
 ## Storybook
 
+To view the component library, run:
+
 ```console
 npm run storybook
 ```
+
+## Usage
+
+Provide examples of how to use the library in a project. Include code snippets and explanations.
+
+```javascript
+import { ComponentName } from '@babylonlabs-io/bbn-core-ui';
+
+function App() {
+  return <ComponentName prop="value" />;
+}
+```
\ No newline at end of file