Skip to content

Improve documentation in the readme #337

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ryanfowler merged 1 commit into from
Aug 24, 2025
Merged

Improve documentation in the readme #337

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 51 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,9 @@ To specify a different quality, add the value after a colon like so:
precompress -c gzip:5 .
```

There are number of file extensions that are compressed by default. To sepcify
the specific extensions to compress, you can use the `-e` flag like so:
There are a number of [file extensions](#default-extensions) that are compressed
by default. To disable that behaviour, you may specify the specific extensions
to compress by using the `-e` flag like so:

```
precompress -e css -e json -e html .
Expand All @@ -80,6 +81,54 @@ or
precompress -c br:5 -c gz:5 -e html -m 4096 .
```

## Default Extensions

Files with the following extensions are compressed by default:

```
atom
cfg
component
conf
css
csv
eot
geojson
graphql
htm
html
ico
java
js
json
jsx
ldjson
log
manifest
map
md
mjs
otf
rss
rtf
scss
sfnt
sitemap
svg
text
ts
tsv
tsx
ttf
txt
wasm
woff
xhtml
xml
yaml
yml
```

## License

`precompress` is released under the MIT license.
Expand Down