ryan/squoosh
1
0
Fork 0
forked from external-repos/squoosh
Code Pull Requests Activity

[DOCS] Remove passive voice, simplify README

Browse Source
This commit is contained in:
Mike DelGaudio
2021-07-05 22:24:20 -04:00
parent ad5002c79c
commit 021b082884
1 changed files with 16 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@@ -1,36 +1,33 @@
# [Squoosh]! # [Squoosh]!
[Squoosh] is an image compression web app that allows you to dive into the advanced options provided [Squoosh] is an image compression web app that provides lossless image quality with a significant reduction to file size.
by various image compressors.
# API & CLI # API & CLI
Squoosh now has [an API](https://github.com/GoogleChromeLabs/squoosh/tree/dev/libsquoosh) and [a CLI](https://github.com/GoogleChromeLabs/squoosh/tree/dev/cli) that allows you to compress many images at once. Squoosh has [an API](https://github.com/GoogleChromeLabs/squoosh/tree/dev/libsquoosh) and [a CLI](https://github.com/GoogleChromeLabs/squoosh/tree/dev/cli) to compress many images at once.
# Privacy # Privacy
Google Analytics is used to record the following: Squoosh does not send your image to a server. All image compression processes locally.
- [Basic visit data](https://support.google.com/analytics/answer/6004245?ref_topic=2919631). However, Squoosh utilizes Google Analytics to collect the following:
- Before and after image size once an image is downloaded. These values are rounded to the nearest
kilobyte.
- If install is available, when Squoosh is installed, and what method was used to install Squoosh.
Image compression is handled locally; no additional data is sent to the server. - [Basic visitor data](https://support.google.com/analytics/answer/6004245?ref_topic=2919631).
- The before and after image size value.
- If Squoosh CLI, the type of Squoosh installation.
- If Squoosh CLI, the installation time and date.
# Building locally # Developing
Clone the repo, and: To develop for Squoosh, use the following:
```sh 1. Clone the repository.
npm install 1. To install node packages, run `npm install`.
npm run build 1. To build the app, run `npm run build`.
``` 1. To start the development server, run `npm run dev`.
You can run the development server with: # Contributing
```sh Squoosh is an open-source project that appreciates all community involvement. To contribute to the project, follow the [contribute guide](/CONTRIBUTING.md).
npm run dev
```
[squoosh]: https://squoosh.app [squoosh]: https://squoosh.app