chore: english text refactoring

brunurd · May 11, 2022 · 6f6b74e · 6f6b74e
1 parent 7767d5d
commit 6f6b74e
Show file tree

Hide file tree

Showing 3 changed files with 149 additions and 146 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -3,7 +3,7 @@ root = true
 [*]
 indent_style = space
 indent_size = 2
-end_of_line = crlf
+end_of_line = lf
 charset = utf-8
 trim_trailing_whitespace = false
 insert_final_newline = false
diff --git a/README.md b/README.md
@@ -1,54 +1,57 @@
-<img align="right" width="100" src="public/images/compy.svg" />
-
-# Companion
-
-[![license][license-badge]](LICENSE.md)
-[![npm-version][npm-version]](https://github.com/brunurd/companion/releases)
-
-Did you know Compy the companion? They are a friendly mini browser to pin on top of any other desktop app and keep doing your things while enjoying a live stream or a youtube video.
-
-### Tested services
-
-|Name|Works|Info|
-|-|-|-|
-|Twitch|:heavy_check_mark:|Ok|
-|Youtube|:heavy_check_mark:|Ok|
-|SoundCloud|:heavy_check_mark:|Ok|
-|Netflix|:x:|DRM problem, needs Widevine|
-|DisneyPlus|:x:|DRM problem|
-
-## Downloads
-:warning: **Observation:** At the moments the releases are made manually, I need time to create a proper continous distribution automation routine, follow the instruction on [How to Compile](#user-content-how-to-compile) if you want a specific version.
-
-[Windows x64][win-download] | [macOS][mac-download] | [Linux][linux-download]
-
-![Screenshot][screenshot]
-
-_Streamer at the screenshot: [@rawrafaela](https://www.twitch.tv/rawrafaela) member of the [@wakandastreamers](https://www.twitch.tv/team/wakandastreamers) team._
-
-## How to Compile
-Pre-requisites:
-- Run on the target platform: Windows, MacOS or Linux (In Linux it uses AppImage)
-- Node.js
-
-Install dependencies with:
-```bash
-npm install
-```
-Run the distribution command:
-```bash
-# For Linux
-npm run dist:linux
-
-# For Windows
-npm run dist:win
-
-# For mac
-npm run dist:mac
-```
-[screenshot]: public/images/screenshot.gif
-[license-badge]: https://img.shields.io/github/license/brunurd/companion
-[npm-version]: https://img.shields.io/github/package-json/v/brunurd/companion
-[linux-download]: https://github.com/brunurd/companion/releases/download/v1.5.5/Companion-1.5.5.AppImage
-[mac-download]: https://github.com/brunurd/companion/releases/download/v1.5.5/Companion-1.5.5.dmg
-[win-download]: https://github.com/brunurd/companion/releases/download/v1.5.5/Companion.1.5.5.exe
+<img align="right" width="100" src="public/images/compy.svg" />
+
+# Companion
+
+[![license][license-badge]](LICENSE.md)
+[![npm-version][npm-version]](https://github.com/brunurd/companion/releases)
+
+Did you know Compy, The Companion? They are a friendly mini browser to pin on top of any other desktop app and keep doing your stuff while enjoying a live stream, video on demand, or consulting any web content.
+
+### Tested services
+
+|Name|Works|Info|
+|-|-|-|
+|Twitch|:heavy_check_mark:|Ok|
+|Youtube|:heavy_check_mark:|Ok|
+|SoundCloud|:heavy_check_mark:|Ok|
+|Netflix|:x:|DRM problem, needs Widevine|
+|DisneyPlus|:x:|DRM problem|
+
+## Downloads
+:warning: **Observation:** The releases are currently deployed manually. I need time to create a proper Continuous Delivery automation routine.  
+Follow the instruction on [How to Compile](#user-content-how-to-compile) if you want a specific version.
+
+
+[Windows x64][win-download] | [macOS][mac-download] | [Linux][linux-download]
+
+![Screenshot][screenshot]
+
+_Streamer at the screenshot: [@rawrafaela](https://www.twitch.tv/rawrafaela) member of the [@wakandastreamers](https://www.twitch.tv/team/wakandastreamers) team._
+
+## How to Compile
+### Pre-requisites
+- Run on the target platform: Windows, MacOS or Linux (In Linux it uses AppImage)
+- Node.js
+
+### Install dependencies with
+```bash
+npm install
+```
+
+### Run the dist command
+```bash
+# For Linux
+npm run dist:linux
+
+# For Windows
+npm run dist:win
+
+# For mac
+npm run dist:mac
+```
+[screenshot]: public/images/screenshot.gif
+[license-badge]: https://img.shields.io/github/license/brunurd/companion
+[npm-version]: https://img.shields.io/github/package-json/v/brunurd/companion
+[linux-download]: https://github.com/brunurd/companion/releases/download/v1.5.5/Companion-1.5.5.AppImage
+[mac-download]: https://github.com/brunurd/companion/releases/download/v1.5.5/Companion-1.5.5.dmg
+[win-download]: https://github.com/brunurd/companion/releases/download/v1.5.5/Companion.1.5.5.exe
diff --git a/package.json b/package.json
@@ -1,91 +1,91 @@
-{
-  "private": true,
-  "name": "companion",
-  "version": "1.6.0",
-  "description": "Did you know Compy the companion? They are a friendly mini browser to pin on top of any other desktop app and keep doing your things while enjoying a live stream or a youtube video.",
-  "main": "public/main.min.js",
-  "build": {
-    "appId": "com.brunurd.companion",
-    "productName": "Companion",
-    "files": "public/**/*",
-    "mac": {
-      "category": "public.app-category.entertainment",
-      "target": "default",
-      "icon": "public/images/favicon.icns"
-    },
-    "win": {
-      "target": "nsis",
-      "icon": "public/images/favicon.ico"
-    },
-    "nsis": {
-      "artifactName": "${productName} ${version}.exe"
-    }
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/brunurd/companion.git"
-  },
-  "keywords": [
-    "youtube",
-    "twitch",
-    "companion",
-    "client",
-    "electron",
-    "always on top",
-    "browser"
-  ],
-  "author": "Bruno Araujo <[email protected]>",
-  "license": "MIT",
-  "homepage": "https://github.com/brunurd/companion#readme",
-  "scripts": {
-    "start": "concurrently \"rollup -cw\" \"node src/delay.js\"",
-    "svelte": "sirv public",
-    "build": "rollup -c",
-    "electron": "electron .",
-    "debug": "electron . debug",
-    "test": "jest",
-    "test:coverage": "jest --coverage --watchAll=false",
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix",
-    "icons": "png2icons ./public/images/compy.png ./public/images/favicon -all -bc -i",
-    "pack": "electron-builder",
-    "pack:dir": "electron-builder --dir",
-    "dist:win": "electron-builder --win --x64",
-    "dist:linux": "electron-builder --linux --x64",
-    "dist:mac": "electron-builder --mac --x64",
-    "postinstall": "install-app-deps"
-  },
-  "devDependencies": {
-    "@babel/core": "^7.12.10",
-    "@babel/preset-env": "^7.12.11",
-    "@electron/remote": "^2.0.8",
-    "@rollup/plugin-commonjs": "^13.0.2",
-    "@rollup/plugin-node-resolve": "^8.4.0",
-    "@testing-library/jest-dom": "^5.11.9",
-    "@testing-library/svelte": "^3.0.3",
-    "ansi-regex": "^6.0.1",
-    "babel-jest": "^26.6.3",
-    "concurrently": "^6.4.0",
-    "electron": "^13.6.6",
-    "electron-builder": "^22.9.1",
-    "electron-reload": "^1.5.0",
-    "eslint": "^7.18.0",
-    "eslint-plugin-svelte3": "^2.7.3",
-    "jest": "^26.6.3",
-    "png2icons": "^2.0.1",
-    "rollup": "^2.38.0",
-    "rollup-plugin-livereload": "^1.3.0",
-    "rollup-plugin-svelte": "^6.1.1",
-    "rollup-plugin-terser": "^6.1.0",
-    "sirv-cli": "^1.0.10",
-    "stylus": "^0.54.8",
-    "svelte": "^3.32.0",
-    "svelte-jester": "^1.3.0",
-    "svelte-preprocess": "^3.9.12"
-  },
-  "jest": {
-    "collectCoverageFrom": [
-      "src/**/*.js"
-    ]
-  }
-}
+{
+  "private": true,
+  "name": "companion",
+  "version": "1.6.0",
+  "description": "Did you know Compy, The Companion? They are a friendly mini browser to pin on top of any other desktop app and keep doing your stuff while enjoying a live stream, video on demand, or consulting any web content.",
+  "main": "public/main.min.js",
+  "build": {
+    "appId": "com.brunurd.companion",
+    "productName": "Companion",
+    "files": "public/**/*",
+    "mac": {
+      "category": "public.app-category.entertainment",
+      "target": "default",
+      "icon": "public/images/favicon.icns"
+    },
+    "win": {
+      "target": "nsis",
+      "icon": "public/images/favicon.ico"
+    },
+    "nsis": {
+      "artifactName": "${productName} ${version}.exe"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/brunurd/companion.git"
+  },
+  "keywords": [
+    "youtube",
+    "twitch",
+    "companion",
+    "client",
+    "electron",
+    "always on top",
+    "browser"
+  ],
+  "author": "Bruno Araujo <[email protected]>",
+  "license": "MIT",
+  "homepage": "https://github.com/brunurd/companion#readme",
+  "scripts": {
+    "start": "concurrently \"rollup -cw\" \"node src/delay.js\"",
+    "svelte": "sirv public",
+    "build": "rollup -c",
+    "electron": "electron .",
+    "debug": "electron . debug",
+    "test": "jest",
+    "test:coverage": "jest --coverage --watchAll=false",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "icons": "png2icons ./public/images/compy.png ./public/images/favicon -all -bc -i",
+    "pack": "electron-builder",
+    "pack:dir": "electron-builder --dir",
+    "dist:win": "electron-builder --win --x64",
+    "dist:linux": "electron-builder --linux --x64",
+    "dist:mac": "electron-builder --mac --x64",
+    "postinstall": "install-app-deps"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.12.10",
+    "@babel/preset-env": "^7.12.11",
+    "@electron/remote": "^2.0.8",
+    "@rollup/plugin-commonjs": "^13.0.2",
+    "@rollup/plugin-node-resolve": "^8.4.0",
+    "@testing-library/jest-dom": "^5.11.9",
+    "@testing-library/svelte": "^3.0.3",
+    "ansi-regex": "^6.0.1",
+    "babel-jest": "^26.6.3",
+    "concurrently": "^6.4.0",
+    "electron": "^13.6.6",
+    "electron-builder": "^22.9.1",
+    "electron-reload": "^1.5.0",
+    "eslint": "^7.18.0",
+    "eslint-plugin-svelte3": "^2.7.3",
+    "jest": "^26.6.3",
+    "png2icons": "^2.0.1",
+    "rollup": "^2.38.0",
+    "rollup-plugin-livereload": "^1.3.0",
+    "rollup-plugin-svelte": "^6.1.1",
+    "rollup-plugin-terser": "^6.1.0",
+    "sirv-cli": "^1.0.10",
+    "stylus": "^0.54.8",
+    "svelte": "^3.32.0",
+    "svelte-jester": "^1.3.0",
+    "svelte-preprocess": "^3.9.12"
+  },
+  "jest": {
+    "collectCoverageFrom": [
+      "src/**/*.js"
+    ]
+  }
+}