Update README

This commit is contained in:
Samuel Štancl 2019-09-18 16:33:49 +02:00
parent edb98deefc
commit 21d0e0cf5a

View file

@ -1,53 +1,3 @@
# Tailwind CSS Playground
# stancl/tenancy docs
A simple starter project for playing around with Tailwind in a proper PostCSS environment.
To get started:
1. Clone the repository:
```bash
git clone https://github.com/tailwindcss/playground.git tailwindcss-playground
cd tailwindcss-playground
```
2. Install the dependencies:
```bash
# Using npm
npm install
# Using Yarn
yarn
```
3. Start the development server:
```bash
# Using npm
npm run serve
# Using Yarn
yarn run serve
```
Now you should be able to see the project running at localhost:8080.
4. Open `public/index.html` in your editor and start experimenting!
## Building for production
Even though this isn't necessarily a starter kit for a proper project, we've included an example of setting up both [Purgecss](https://www.purgecss.com/) and [cssnano](https://cssnano.co/) to optimize your CSS for production.
To build an optimized version of your CSS, simply run:
```bash
# Using npm
npm run production
# Using Yarn
yarn run production
```
After that's done, check out `./public/build/tailwind.css` to see the optimized output.
For the main repository, see [stancl/tenancy](https://github.com/stancl/tenancy).