From 021b082884d875d7ea451e43591c8966689b132d Mon Sep 17 00:00:00 2001 From: Mike DelGaudio Date: Mon, 5 Jul 2021 22:24:20 -0400 Subject: [PATCH 1/5] [DOCS] Remove passive voice, simplify README --- README.md | 35 ++++++++++++++++------------------- 1 file changed, 16 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 203703d3..976de058 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,33 @@ # [Squoosh]! -[Squoosh] is an image compression web app that allows you to dive into the advanced options provided -by various image compressors. +[Squoosh] is an image compression web app that provides lossless image quality with a significant reduction to file size. # 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 -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). -- 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. +However, Squoosh utilizes Google Analytics to collect the following: -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 -npm install -npm run build -``` +1. Clone the repository. +1. To install node packages, run `npm install`. +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 -npm run dev -``` +Squoosh is an open-source project that appreciates all community involvement. To contribute to the project, follow the [contribute guide](/CONTRIBUTING.md). [squoosh]: https://squoosh.app From d953822d19f6260cf1881406ae80de05f16a548f Mon Sep 17 00:00:00 2001 From: Mike DelGaudio Date: Mon, 5 Jul 2021 22:37:04 -0400 Subject: [PATCH 2/5] [DOCS] Remove passive voice, simplify README --- README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 976de058..29c54b13 100644 --- a/README.md +++ b/README.md @@ -21,10 +21,19 @@ However, Squoosh utilizes Google Analytics to collect the following: To develop for Squoosh, use the following: -1. Clone the repository. -1. To install node packages, run `npm install`. -1. To build the app, run `npm run build`. -1. To start the development server, run `npm run dev`. +1. Clone the repository +1. Install node packages, by running: + ```sh + npm install + ``` +1. Build the app, by running: + ```sh + npm run build + ``` +1. Start the development server, by running: + ```sh + npm run dev + ``` # Contributing From fe21322b2bf174567e2fa491453b6ea15e6aec9a Mon Sep 17 00:00:00 2001 From: Mike DelGaudio Date: Tue, 6 Jul 2021 14:34:04 -0400 Subject: [PATCH 3/5] [DOCS] Update list of develop steps --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 29c54b13..74ad75ac 100644 --- a/README.md +++ b/README.md @@ -19,18 +19,18 @@ However, Squoosh utilizes Google Analytics to collect the following: # Developing -To develop for Squoosh, use the following: +To develop for Squoosh: 1. Clone the repository -1. Install node packages, by running: +1. To install node packages, run: ```sh npm install ``` -1. Build the app, by running: +1. Then build the app by running: ```sh npm run build ``` -1. Start the development server, by running: +1. After building, start the development server by running: ```sh npm run dev ``` From 192cfc62ee85037769a203478a7097facdb25201 Mon Sep 17 00:00:00 2001 From: Mike DelGaudio <43451174+mikedelgaudio@users.noreply.github.com> Date: Wed, 7 Jul 2021 09:57:44 -0400 Subject: [PATCH 4/5] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 74ad75ac..733526b5 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,8 @@ However, Squoosh utilizes Google Analytics to collect the following: - [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. +- If Squoosh PWA, the type of Squoosh installation. +- If Squoosh PWA, the installation time and date. # Developing From d4d0db6c49c322bfeabe6bab5d271c3a4b4213f3 Mon Sep 17 00:00:00 2001 From: Mike DelGaudio <43451174+mikedelgaudio@users.noreply.github.com> Date: Mon, 19 Jul 2021 11:47:52 -0400 Subject: [PATCH 5/5] update header statement --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 733526b5..f60b0935 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # [Squoosh]! -[Squoosh] is an image compression web app that provides lossless image quality with a significant reduction to file size. +[Squoosh] is an image compression web app that reduces image sizes through numerous formats. # API & CLI