Skip to content

Commit

Permalink
feat(doc): add doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Charlie85270 committed Dec 27, 2020
1 parent 94921c1 commit 045a9e1
Showing 1 changed file with 60 additions and 37 deletions.
97 changes: 60 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,31 @@
![version](https://img.shields.io/badge/version-1.0.0-blue.svg) ![license](https://img.shields.io/badge/license-MIT-blue.svg) ![GitHub issues](https://img.shields.io/github/issues/Charlie85270/fastUI) <a href="https://www.tailwind-kit.com/" target="_blank">
![GitHub Repo stars](https://img.shields.io/github/stars/Charlie85270/fastUI?style=social)

![Tailwind Starter Kit](https://i.ibb.co/mRSKQ04/Capture-d-e-cran-2020-12-27-a-11-35-11.png)

![Tailwind-Kit](https://i.ibb.co/mRSKQ04/Capture-d-e-cran-2020-12-27-a-11-35-11.png)
</a>
### A beautiful and large components kit for TailwindCSS 2.0

Tailwind-kit is Free and Open Source. It does not change or add any CSS to the already one from TailwindCSS 2.0. It features multiple HTML elements that can be used in all web projects who's use tailwind CSS.

### CSS Components
## CSS Components

Tailwind Starter Kit comes with 180+ Fully Coded CSS elements and layouts.

## Live code editor
![Tailwind-Kit](https://i.ibb.co/g3n4NMg/Capture-d-e-cran-2020-12-27-a-12-06-16.png)
Tailwind-kit include a live code editor to change the components code and see in live the modification.


## Dark mode
![Tailwind-Kit](https://www.tailwind-kit.com/demo.gif)

Most components are implemented with a light and dark version, with the new dark mode 2.0 feature of tailwind CSS.


## Documentation
The documentation for the Tailwind-kit is hosted at our <a href="https://www.tailwind-kit.com/started" target="_blank">website</a>.

## Quick start

- <a href="https://github.com/creativetimofficial/tailwind-starter-kit/archive/master.zip" target="_blank">Download from Github</a>.
- <a href="https://github.com/creativetimofficial/tailwind-starter-kit" target="_blank">Check it on Github</a>.

## Browser Support

Expand All @@ -29,52 +37,67 @@ At present, we officially aim to support the last two versions of the following
|:---:|:---:|:---:|:---:|:---:|
| <img src="https://github.com/creativetimofficial/public-assets/blob/master/logos/chrome-logo.png?raw=true" width="64" height="64"> | <img src="https://raw.githubusercontent.com/creativetimofficial/public-assets/master/logos/firefox-logo.png" width="64" height="64"> | <img src="https://raw.githubusercontent.com/creativetimofficial/public-assets/master/logos/edge-logo.png" width="64" height="64"> | <img src="https://raw.githubusercontent.com/creativetimofficial/public-assets/master/logos/safari-logo.png" width="64" height="64"> | <img src="https://raw.githubusercontent.com/creativetimofficial/public-assets/master/logos/opera-logo.png" width="64" height="64"> |

## Reporting Issues
## Reporting Issues/ make Pull request

We use GitHub Issues as the official bug tracker for the Angular Landing Page. Here are some advices for our users that want to report an issue:
Every Issues, and PR are welcome !
the site is not perfect, there must be typos, bugs, improvements.
Do not hesitate to contribe and add your own components/layout.

1. Make sure that you are using the latest version of the Angular Landing Page. Check the CHANGELOG from your dashboard on our <a href="https://www.creative-tim.com/?ref=tsk-readme" target="_blank">website</a>.
2. Providing us reproducible steps for the issue will shorten the time it takes for it to be fixed.
3. Some issues may be browser specific, so specifying in what browser you encountered the issue might help.

## Licensing

- Copyright 2019 <a href="https://www.creative-tim.com/?ref=tsk-readme" target="_blank">Creative Tim</a>
## Getting Started

![Tailwind-Kit](https://camo.githubusercontent.com/6202639220e8972265da4543eb10e428adbf579b8a07fc427bc90b383647a3c9/68747470733a2f2f7777772e6a6f616f706564726f2e63632f696d672f6769746875622f747970657363726970742d6e6578746a732d737461727465722e706e67)


Tailwind-kit is a static site build with [Next.js](https://nextjs.org/) and typescript.

Install dependencies:

```bash
npm install
# or
yarn install
```

- Licensed under <a href="https://github.com/creativetimofficial/tailwind-starter-kit/blob/master/LICENSE.md" target="_blank">MIT</a>
Run the development server:

## Useful Links
```bash
npm run dev
# or
yarn dev
```

- <a href="https://www.youtube.com/channel/UCVyTG4sCw-rOvB9oHkzZD1w" target="_blank">Tutorials</a>
- <a href="https://www.creative-tim.com/affiliates/new?ref=tsk-readme" target="_blank">Affiliate Program</a> (earn money)
- <a href="http://blog.creative-tim.com/?ref=tsk-readme" target="_blank">Blog Creative Tim</a>
- <a href="https://www.creative-tim.com/templates/free?ref=tsk-readme" target="_blank">Free Products</a> from Creative Tim
- <a href="https://www.creative-tim.com/templates/premium?ref=tsk-readme" target="_blank">Premium Products</a> from Creative Tim
- <a href="https://www.creative-tim.com/templates/react?ref=tsk-readme" target="_blank">React Products</a> from Creative Tim
- <a href="https://www.creative-tim.com/templates/angular?ref=tsk-readme" target="_blank">Angular Products</a> from Creative Tim
- <a href="https://www.creative-tim.com/templates/vuejs?ref=tsk-readme" target="_blank">VueJS Products</a> from Creative Tim
- <a href="https://www.creative-tim.com/templates?ref=tsk-readme" target="_blank">More products</a> from Creative Tim
- Check our Bundles <a href="https://www.creative-tim.com/bundles?ref=tsk-readme" target="_blank">here</a>
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

### Social Media
You can start editing the page by modifying `pages/_index.tsx`. The page auto-updates as you edit the file (static folder : /out).

Twitter: <a href="https://twitter.com/CreativeTim" target="_blank">https://twitter.com/CreativeTim</a>

Facebook: <a href="https://www.facebook.com/CreativeTim" target="_blank">https://www.facebook.com/CreativeTim</a>
Build the static site:

```bash
npm run build
# or
yarn build
```


## Learn More

To learn more about Next.js, take a look at the following resources:

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!


## Licensing

Dribbble: <a href="https://dribbble.com/creativetim" target="_blank">https://dribbble.com/creativetim</a>
- Copyright 2020 Charlie Rabiller</a>

Instagram: <a href="https://www.instagram.com/creativetimofficial/" target="_blank">https://www.instagram.com/creativetimofficial/</a>

- Licensed under <a href="https://github.com/Charlie85270/fastUI/blob/main/README.md" target="_blank">MIT</a>

## Resources
- Demo: <a href="https://www.creative-tim.com/learning-lab/tailwind-starter-kit/#/presentation?ref=tsk-readme" target="_blank">https://www.creative-tim.com/learning-lab/tailwind-starter-kit/#/presentation?ref=tsk-readme</a>
- Download Page: <a href="https://github.com/creativetimofficial/tailwind-starter-kit/archive/master.zip" target="_blank">https://github.com/creativetimofficial/tailwind-starter-kit/archive/master.zip</a>
- Documentation: <a href="https://www.creative-tim.com/learning-lab/tailwind-starter-kit/#/documentation/quick-start?ref=tsk-readme" target="_blank">https://www.creative-tim.com/learning-lab/tailwind-starter-kit/#/documentation/quick-start?ref=tsk-readme</a>
- License Agreement: <a href="https://www.creative-tim.com/license?ref=tsk-readme" target="_blank">https://www.creative-tim.com/license?ref=tsk-readme</a>
- Support: <a href="https://www.creative-tim.com/contact-us?ref=tsk-readme" target="_blank">https://www.creative-tim.com/contact-us?ref=tsk-readme</a>
- Issues: <a href="https://github.com/creativetimofficial/tailwind-starter-kit/issues" target="_blank">Github Issues Page</a>


0 comments on commit 045a9e1

Please sign in to comment.