Skip to content

Commit 4bf09bb

Browse files
docs: Add prerequisites section and fix grammar in README.md
1 parent ad21f7c commit 4bf09bb

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,29 @@
22
<a href="https://floatui.com/" rel="noopener" target="_blank"><img width="200" src="public/logo.svg" alt="Float UI logo"></a>
33
</p>
44

5-
Float UI is collection of modern UI components and website templates built on top of React, and Vue (soon) with Tailwind CSS, the components are beautiful designed, expertly crafted, allow you to build beautiful websites.
5+
Float UI is a collection of modern UI components and website templates built on top of React, and soon, Vue. With Tailwind CSS, the components are beautifully designed and expertly crafted, allowing you to build beautiful websites.
66

77
## Why Float UI?
88

9-
First, Float UI is fully free, and open source, you don't need to pay anything to use it, and we are working on it full-time, so we'll keep improving, and adding more UIs, the second thing if you’re working on a large project that requires a high level of UI customization or you find yourself repeating the same UI patterns across projects, consider creating an internal UI library, and in this case Float UI is a great choice. You should definitely use it.
9+
Float UI is fully free and open source. You don't need to pay anything to use it, and we are working on it full-time, so we'll keep improving and adding more UIs. If you’re working on a large project that requires a high level of UI customization or you find yourself repeating the same UI patterns across projects, consider creating an internal UI library. In this case, Float UI is a great choice. You should definitely use it.
10+
11+
## Prerequisites
12+
13+
Before you begin, ensure you have met the following requirements:
14+
15+
* You have installed the latest version of npm/yarn/pnpm.
16+
* You have a `Windows/Linux/Mac` machine.
1017

1118
## Getting Started
1219

13-
First, install the dependencies we highly recommend using pnpm, and run the development server:
20+
First, install the dependencies. We highly recommend using pnpm, and run the development server:
1421

1522
```bash
1623
npm run dev
1724
# or
1825
yarn dev
1926
# or
2027
pnpm dev
21-
```
2228

2329
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
2430

0 commit comments

Comments
 (0)