Skip to content

Commit

Permalink
Added emojis for each section in README (vczb#108)
Browse files Browse the repository at this point in the history
closes vczb#107
  • Loading branch information
Divyesh1511 authored Oct 8, 2023
1 parent 94bd611 commit e0b61a7
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

It's a simple and faster React UI

## Installation
## Installation 🛠️

sagu-ui is available as an [npm package](https://www.npmjs.com/package/sagu-ui).

Expand All @@ -18,7 +18,7 @@ To install it, run:

_[styled-components](https://github.com/styled-components/styled-components) package is required_

## Usage
## Usage 👇

Here is a quick example to get you started, **it's all you need**:

Expand All @@ -38,7 +38,7 @@ function App() {
export default App
```

## Theme customization
## Theme customization ✒️

You can easily override the values of the theme object

Expand Down Expand Up @@ -89,7 +89,7 @@ export const CustomWrapper = styled.div`
`
```

## Component customization
## Component customization 🔧

You have too many ways to customize the Sagu components

Expand Down Expand Up @@ -140,15 +140,15 @@ import './styles.css'
<Button className="button-green">My Button</Button>
```

## Examples
## Examples ✍️

Take a look at some [examples](./EXAMPLES.md) using [Sagu-UI](https://www.npmjs.com/package/sagu-ui)

## Contributing
## Contributing 🤝

You can contribute to this project by opening an issue or creating a pull request.

## What is inside?
## What is inside

- [TypeScript](https://www.typescriptlang.org/)
- [Styled Components](https://styled-components.com/)
Expand All @@ -157,7 +157,7 @@ You can contribute to this project by opening an issue or creating a pull reques
- [Prettier](https://prettier.io/)
- [Jest](https://jestjs.io/)

## Available commands
## Available commands ⬇️

- `build`: build the files in the `lib` directory
- `sb`: run the storybook at the address `localhost:6006`
Expand All @@ -166,7 +166,7 @@ You can contribute to this project by opening an issue or creating a pull reques
- `generate <Component name>`: create a component boilerplate
- `test`: test all components

## Project structure
## Project structure 🧬

```
/.storybook
Expand Down Expand Up @@ -198,6 +198,6 @@ Thanks for all who is contributing with us.

Be part of this amazing team, [contribute](./CONTRIBUTING.md) as well

## License
## License 🪪

This project is licensed under the [MIT](./LICENSE) License.

0 comments on commit e0b61a7

Please sign in to comment.