modern-css-reset/README.md

67 lines
1.4 KiB
Markdown
Raw Permalink Normal View History

2019-10-01 06:02:39 -07:00
# A modern CSS reset
2019-10-01 07:20:28 -07:00
2019-10-01 17:19:21 -07:00
![The Uncompressed size of this reset](https://img.badgesize.io/https://unpkg.com/modern-css-reset?label=Uncompressed%20Size)
![The GZIP size of this reset](https://img.badgesize.io/https://unpkg.com/modern-css-reset?compression=gzip&label=GZIP%20Size)
![The Brotli size of this reset](https://img.badgesize.io/https://unpkg.com/modern-css-reset?compression=brotli&label=Brotli%20Size)
2019-10-01 07:26:55 -07:00
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
A tiny little reset that you can use as the basis of your CSS projects. You can
read
a [breakdown of it here](https://hankchizljaw.com/wrote/a-modern-css-reset/).
2019-10-01 07:20:28 -07:00
2019-10-01 17:18:23 -07:00
## Installation
2020-01-23 14:09:15 -08:00
NPM:
2019-10-01 17:18:23 -07:00
2020-01-23 11:31:48 -08:00
```console
npm install --save-dev @punkfairie/modern-css-reset
2020-01-23 11:31:48 -08:00
```
2020-01-23 14:09:15 -08:00
Yarn:
2020-01-23 11:31:48 -08:00
```console
yarn add @punkfairie/modern-css-reset
2020-01-23 11:31:48 -08:00
```
Unpkg CDN:
2020-01-23 11:31:48 -08:00
```html
<link rel="stylesheet"
href="https://unpkg.com/@punkfairie/modern-css-reset/dist/reset.min.css"/>
2020-01-23 11:31:48 -08:00
```
jsDelivr CDN:
2020-01-23 11:31:48 -08:00
```html
<link rel="stylesheet"
href="https://cdn.jsdelivr.net/npm/@punkfairie/modern-css-reset/dist/reset.min.css"/>
2020-01-23 11:31:48 -08:00
```
2020-01-23 11:32:33 -08:00
### Manual installation
2019-10-01 07:20:28 -07:00
2020-01-23 14:07:21 -08:00
First, let's clone this repository:
2019-10-01 07:20:28 -07:00
2020-01-23 11:31:48 -08:00
```console
git clone https://github.com/punkfairie/modern-css-reset.git
2019-10-01 07:20:28 -07:00
```
2020-01-23 11:31:48 -08:00
2020-01-23 14:07:21 -08:00
Then, go to `modern-css-reset` directory:
```console
cd modern-css-reset
```
And now, you can minify and move the main reset to the `dist` by running:
```console
npm run build
```
That's it! 🎉
2020-01-23 11:31:48 -08:00
## License
MIT