external-repos/squoosh
1
0
Fork 1
mirror of https://github.com/GoogleChromeLabs/squoosh.git synced 2025-11-12 08:47:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1093 from mikedelgaudio/update-readme

Browse Source 
[DOCS] Update README, Remove Passive Voice
This commit is contained in:
Surma
2021-07-19 17:27:54 +01:00
committed by GitHub
parent 0719abff27 f848a9384e
commit bf683cdf59
1 changed files with 25 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
README.md
View File

@@ -1,36 +1,42 @@
# [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 reduces image sizes through numerous formats.
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 PWA, the type of Squoosh installation.
- If Squoosh PWA, the installation time and date.
# Building locally # Developing
Clone the repo, and: To develop for Squoosh:
```sh 1. Clone the repository
npm install 1. To install node packages, run:
npm run build ```sh
``` npm install
```
1. Then build the app by running:
```sh
npm run build
```
1. After building, start the development server by running:
```sh
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