Skip to content

Commit 3f115c6

Browse files
docs(readme): refer to theme docs page in README (#615)
This information needs to be extremely accessible now. Co-authored-by: Ricardo Lüders <ricardo@luders.com.br>
1 parent 05bde49 commit 3f115c6

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,21 +57,19 @@ If you want to learn more about Flowbite, visit [Flowbite docs](https://flowbite
5757

5858
## Getting started
5959

60-
To use `flowbite-react`, you just need to setup `flowbite` normally and install `flowbite-react` from `npm`.
60+
Make sure you have [Node.js](https://nodejs.org/en/) installed.
6161

62-
`flowbite` can be included as a plugin into an existing Tailwind CSS project.
63-
64-
### Require via `npm`
62+
To use `flowbite-react`, you need to setup [`flowbite`](https://github.com/themesberg/flowbite) and also install `flowbite-react` from `npm` or `yarn`.
6563

66-
Make sure that you have <a href="https://nodejs.org/en/" rel="nofollow" >Node.js</a> and <a href="https://tailwindcss.com/" rel="nofollow" >Tailwind CSS</a> installed.
64+
`flowbite` can be included as a plugin into an existing Tailwind CSS project.
6765

6866
1. Install `flowbite` as a dependency using `npm` by running the following command:
6967

7068
```bash
71-
npm i flowbite flowbite-react
69+
npm i flowbite flowbite-react # or yarn add flowbite flowbite-react
7270
```
7371

74-
2. Require `flowbite` as a plugin inside the `tailwind.config.js` file:
72+
2. Require `flowbite` as a plugin inside the `tailwind.config.js` file, and include content from `flowbite-react`:
7573

7674
```javascript
7775
module.exports = {
@@ -80,9 +78,16 @@ module.exports = {
8078
'node_modules/flowbite-react/**/*.{js,jsx,ts,tsx}'
8179
],
8280
plugins: [..., require('flowbite/plugin')],
81+
...
8382
};
8483
```
8584

85+
## Customize components
86+
87+
You can customize every component in `flowbite-react`. We've provided a few different methods so just about any use case you have should be covered for now.
88+
89+
See [https://flowbite-react.com/theme](https://flowbite-react.com/theme)
90+
8691
## Components
8792

8893
<table>

0 commit comments

Comments
 (0)