From 9ee6a0a12aea3d8f22757d14ce6b2d0eaf7af4d8 Mon Sep 17 00:00:00 2001 From: Alwin T <75517758+alwinsDen@users.noreply.github.com> Date: Thu, 7 Mar 2024 23:34:51 +0530 Subject: [PATCH] Update README.md --- README.md | 33 +++++++++++++++++++++++++++------ 1 file changed, 27 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 7cf919c..71643a4 100644 --- a/README.md +++ b/README.md @@ -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 ( + + Click me. + + ); +} +export default App; + ``` ## Contributing -### Clone the repository +#### Clone the repository ```shell git clone git@github.com: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 -``` \ No newline at end of file +```