-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
27 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` | ||
``` |