Skip to content

Commit 35cd80f

Browse files
committed
Update README
1 parent b7ed353 commit 35cd80f

File tree

1 file changed

+24
-15
lines changed

1 file changed

+24
-15
lines changed

README.md

Lines changed: 24 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,24 @@
22

33
A bare-bones Tailwind CSS boilerplate.
44

5-
It creates a simple HTML + CSS template with [Tailwind CSS](https://tailwindcss.com)
6-
support, served by [Parcel](https://parceljs.org) and using [PurgeCSS](https://purgecss.com)
7-
in production builds.
5+
It creates a simple HTML + CSS template with [Tailwind CSS][tailwind] support,
6+
served by [Parcel][parcel] and using [PurgeCSS][purgecss] in production builds.
87

98
## Getting started
109

1110
### Requirements
1211

13-
[Yarn](https://yarnpkg.com) is suggested, but not required. The project will be
14-
set up with [npm](https://www.npmjs.com/get-npm) if Yarn is not found.
12+
[Yarn][yarn] is suggested, but not required. The project will be set up with
13+
[npm][npm] if Yarn is not found.
1514

1615
### Create boilerplate
1716

1817
```bash
19-
$ yarn create tailwindcss-boilerplate
18+
yarn create tailwindcss-boilerplate
2019

2120
# or
2221

23-
$ npx create-tailwindcss-boilerplate
22+
npx create-tailwindcss-boilerplate
2423
```
2524

2625
Follow instructions at the prompt to create your project:
@@ -36,30 +35,40 @@ Follow instructions at the prompt to create your project:
3635
### Run server
3736

3837
```bash
39-
$ yarn dev
38+
yarn dev
4039
```
4140

4241
Open your favorite text editor and start coding!
4342

4443
## Build for production
4544

4645
```bash
47-
$ yarn build
46+
yarn build
4847
```
4948

5049
Build files will end up in `/dist`.
5150

5251
## Contributing
5352

5453
If you want to add a feature, fix a bug or propose a change, please feel free to
55-
[submit an issue](https://github.com/michelegera/create-tailwindcss-boilerplate/issues/new) or [open a pull request](https://github.com/michelegera/create-tailwindcss-boilerplate/compare).
54+
[submit an issue][issue] or [open a pull request][pr].
5655

57-
Thanks to [all the contributors](https://github.com/michelegera/create-tailwindcss-boilerplate/graphs/contributors)!
56+
Thanks to [all the contributors][contributors]!
5857

5958
## Acknowledgments
6059

6160
This project piggybacks on the excellent [TailwindCSS + Parcel + PurgeCSS
62-
Starter Project](https://github.com/didiercatz/tailwindcss-parcel-boilerplate)
63-
by [didiercatz](https://github.com/didiercatz). Check out his [blog
64-
post](https://dev.to/didiercatz/getting-started-with-tailwindcss-in-seconds-8p2)
65-
on getting started with Tailwind CSS.
61+
Starter Project][starter-project] by [didier][didier]. Check out his
62+
[blog post][blog-post] on getting started with Tailwind CSS.
63+
64+
[tailwind]: https://tailwindcss.com
65+
[parcel]: https://parceljs.org
66+
[purgecss]: https://purgecss.com
67+
[yarn]: https://yarnpkg.com
68+
[npm]: https://www.npmjs.com
69+
[issue]: https://github.com/michelegera/create-tailwindcss-boilerplate/issues/new
70+
[pr]: https://github.com/michelegera/create-tailwindcss-boilerplate/compare
71+
[contributors]: https://github.com/michelegera/create-tailwindcss-boilerplate/graphs/contributors
72+
[starter-project]: https://github.com/didier/tailwindcss-parcel-boilerplate
73+
[didier]: https://github.com/didier
74+
[blog-post]: https://dev.to/didier/getting-started-with-tailwindcss-in-seconds-8p2

0 commit comments

Comments
 (0)