Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jeremy-babylonlabs committed Nov 22, 2024
1 parent f6938aa commit beef01a
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 2 deletions.
5 changes: 5 additions & 0 deletions .changeset/fast-boxes-hope.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@babylonlabs-io/bbn-core-ui": patch
---

update readme.MD
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" />;
}
```

0 comments on commit beef01a

Please sign in to comment.