Update README

This commit is contained in:
0x1eef 2024-08-03 00:52:26 -03:00
parent c2c43ec193
commit 9adc8ea165

View file

@ -2,19 +2,16 @@
tail.css provides _a small subset_ of tail.css provides _a small subset_ of
[tailwind](https://tailwindcss.com/) [tailwind](https://tailwindcss.com/)
that was originally extracted from a hobby project. A prebuilt copy of that was originally extracted from a hobby project.
[dist/tail.css](dist/tail.css) The CSS file [dist/tail.css](dist/tail.css)
is provided in case you don't have access to the nodejs sass compiler, is provided in case you don't have access to
along with a minimized copy the nodejs sass compiler
([dist/tail.min.css](dist/tail.min.css)). - alongside [a minimized copy](dist/tail.min.css).
There are gzip-compressed copies of those files included in
[dist/](dist/)
... `tail.css.min.gz` weighs in at around 8.5KB.
## Rationale ## Rationale
The motivation behind this project is to be able to use tailwind The motivation behind this project is to be able to use tailwind
without a nodejs environment. You can use tail.css within a vanilla without a nodejs environment. tail.css can be used within a vanilla
CSS environment, or within an environment that uses CSS environment, or within an environment that uses
[sass](https://sass-lang.com). [sass](https://sass-lang.com).
Most of the time I use tail.css within a sass environment, and Most of the time I use tail.css within a sass environment, and
@ -22,9 +19,9 @@ sprinkle small amounts of CSS on top.
## Build ## Build
Custom builds provide a way to customize what features are Custom builds can customize what features are included in a build.
included in a build. The `@import` directives in [src/](src/) The `@import` directives in [src/](src/) decide what features to
decide what features to include: include:
$ npm install -g sass $ npm install -g sass
$ bin/build $ bin/build
@ -34,13 +31,13 @@ decide what features to include:
Copyright of src/tail/ belongs to the Copyright of src/tail/ belongs to the
[tailwind project](https://tailwindcss.com/). [tailwind project](https://tailwindcss.com/).
<br> <br>
See [tailwindcss/LICENSE](https://github.com/tailwindlabs/tailwindcss/blob/master/LICENSE). See [tailwindcss/LICENSE](https://github.com/tailwindlabs/tailwindcss/blob/master/LICENSE)
Copyright of src/normalize/ belongs to the Copyright of src/normalize/ belongs to the
[normalize.css project](https://raw.githubusercontent.com/necolas/normalize.css). [normalize.css project](https://raw.githubusercontent.com/necolas/normalize.css).
<br> <br>
See [normalize/LICENSE.md](https://github.com/necolas/normalize.css/blob/master/LICENSE.md). See [normalize/LICENSE.md](https://github.com/necolas/normalize.css/blob/master/LICENSE.md)
The remaining copyright is covered by the [0BSD License](https://choosealicense.com/licenses/0bsd/). The remaining copyright is covered by the [0BSD License](https://choosealicense.com/licenses/0bsd/).
<br> <br>
See [./LICENSE](./LICENSE). See [./LICENSE](./LICENSE)