Skip to content

Commit

Permalink
Update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
zoltanszogyenyi committed Oct 30, 2021
1 parent ecbb7f4 commit 9067143
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 2 deletions.
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,38 @@ There are multiple ways that you can include it into your project.

## Require via NPM

You can also require FlowBite as a dependency using NPM by running the following command:
Make sure that you have <a href="https://nodejs.org/en/" rel="nofollow" target="_blank">Node.js</a> and <a href="https://tailwindcss.com/" rel="nofollow" target="_blank">Tailwind CSS</a> installed.

1. Install Flowbite as a dependency using NPM by running the following command:

```bash
npm i @themesberg/flowbite
```

2. Require Flowbite as a plugin inside the `tailwind.config.js` file:

```javascript
module.exports = {

plugins: [
require('@themesberg/flowbite/plugin'),
],

}
```

3. Include the main JavaScript file to make interactive elements work:

```html
<script src="../path/to/@themesberg/flowbite/dist/flowbite.bundle.js"></script>
```

If you use Webpack or other bundlers you can also import it like this:

```javascript
import '@themesberg/flowbite';
```

## Include via CDN

The quickest way to get started working with FlowBite is to simply include the CSS and JavaScript into your project via CDN.
Expand Down
3 changes: 2 additions & 1 deletion content/getting-started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Flowbite is a library of components built on top of the utility-classes from Tai

Make sure that you have <a href="https://nodejs.org/en/" rel="nofollow" target="_blank">Node.js</a> and <a href="https://tailwindcss.com/" rel="nofollow" target="_blank">Tailwind CSS</a> installed.

1. Then install Flowbite as a dependency using NPM by running the following command:
1. Install Flowbite as a dependency using NPM by running the following command:

```bash
npm i @themesberg/flowbite
Expand Down Expand Up @@ -62,6 +62,7 @@ And include the following javascript file before the end of the `body` element:
```html
<script src="https://unpkg.com/@themesberg/flowbite@{{< current_version >}}/dist/flowbite.bundle.js"></script>
```

## Github repository

The source files are also available to be cloned or downloaded from the official <a href="https://github.com/themesberg/flowbite" target="_blank">FlowBite Github repository</a>. Don't forget to give it a star if you appreciate the project.

0 comments on commit 9067143

Please sign in to comment.