Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Pagebakers committed Jan 4, 2024
1 parent e2456a5 commit 4be4905
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 24 deletions.
6 changes: 1 addition & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ This repository contains all [open source components](/packages), as well as the

## Links

💡 [Documentation](https://saas-ui.dev/docs/introduction)
💡 [Documentation](https://saas-ui.dev/docs)

🧭 [Roadmap](https://roadmap.saas-ui.dev)

Expand Down Expand Up @@ -90,10 +90,6 @@ yarn

### Storybook

https://storybook.saas-ui.pro

Or run locally:

```bash
yarn storybook
```
Expand Down
45 changes: 26 additions & 19 deletions packages/saas-ui-react/README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,46 @@
# Saas UI - The React component library for startups

Saas UI is an advanced component library that helps you build intuitive React apps with speed.
<p align='center'>
<img src="./apps/website/public/saasui.svg#gh-light-mode-only" alt="Saas UI logo" height="60px" />
<img src="./apps/website/public/saasui-dark.svg#gh-dark-mode-only" alt="Saas UI logo" height="60px" />
</p>

It's built on top of Chakra UI and fully written in Typescript.
<p align='center'>The React component library for Startups</p>

<p>
<p align="center">
<a href="https://www.npmjs.com/package/@saas-ui/react">
<img src="https://img.shields.io/npm/v/@saas-ui/react" alt="NPM">
</a>
<a href="https://www.npmjs.com/package/@saas-ui/react">
<img src="https://img.shields.io/npm/dm/@saas-ui/react.svg" alt="npm downloads">
</a>
<img alt="MIT License" src="https://img.shields.io/github/license/saas-js/saas-ui"/>
<a href="https://twitter.com/intent/follow?screen_name=saas_js">
<img src="https://img.shields.io/twitter/follow/saas_js?style=social&logo=twitter" alt="follow on Twitter">
<img src="https://img.shields.io/twitter/follow/saas_js" alt="follow on Twitter">
</a>
</p>

## Installation
<hr />

Saas UI is an advanced component library designed to build beautiful B2B and dashboard style apps with speed.
It's built on top of Chakra UI and fully written in Typescript.

## Links

```sh
$ yarn add @saas-ui/react
💡 [Documentation](https://saas-ui.dev/docs)

#or
🧭 [Roadmap](https://roadmap.saas-ui.dev)

$ npm i @saas-ui/react --save
```
🖼 [Storybooks](https://storybook.saas-ui.pro)

## Documentation
🌟 [Saas UI Pro](https://saas-ui.dev/#pro-features)

You can find the documentation on our website:
## Sponsors ❤️

https://www.saas-ui.dev/docs
Saas UI is sponsored by these amazing companies and people.

## Storybook
- [LocalXPose](https://localxpose.io/)

https://storybook.saas-ui.dev
## Contributing & Support

## License
Want to help? Great! Check out the [contributing guidelines](CONTRIBUTING.md) and feel free to open a PR or [discussion](https://github.com/saas-js/saas-ui/discussions/new) for feature requests and feedback.

MIT - Appulse Software
If you'd like to support the project financially, you can [become a sponsor](https://github.com/sponsors/saas-js) of Saas UI or consider ordering [Saas UI Pro Beta](https://saas-ui.lemonsqueezy.com/checkout/buy/5c76854f-738a-46b8-b32d-932a97d477f5). All funds will go toward the further development of Saas UI. This will give you access to the private Git repository with the beta and our private Discord server for support.

0 comments on commit 4be4905

Please sign in to comment.