Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alwinsDen authored Mar 7, 2024
1 parent e8fb76e commit 9ee6a0a
Showing 1 changed file with 27 additions and 6 deletions.
33 changes: 27 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,51 @@
# Ananya UI

**npm registry:** https://www.npmjs.com/package/@alwinsden/ananya-ui

## Installation and usage

### Add the library to project
#### Add the library to project
```shell
npm i @alwinsden/ananya-ui
```
#### Import the CSS properties in root file [index.tsx]
```shell
import "@alwinsden/ananya-ui/dist/style.css"
```

#### Adding a default button from library
```javascript
import {AnUIDefaultButton} from "@alwinsden/ananya-ui";
import './App.css';
function App() {
return (
<AnUIDefaultButton>
Click me.
</AnUIDefaultButton>
);
}
export default App;

```

## Contributing

### Clone the repository
#### Clone the repository
```shell
git clone [email protected]:alwinsDen/ananya-ui.git
```

### Install required dependencies
#### Install required dependencies
```shell
npm install
```

### Create a usable build of the library
#### Create a usable build of the library
```shell
npm run build
```

### Code reformatting
#### Code reformatting
```shell
prettier . --write
```
```

0 comments on commit 9ee6a0a

Please sign in to comment.