v0.1.0

Protoqol · Jun 7, 2022 · cf9f395 · cf9f395
1 parent 98372c6
commit cf9f395
Show file tree

Hide file tree

Showing 4 changed files with 72 additions and 49 deletions.
diff --git a/.github/README.md b/.github/README.md
@@ -15,12 +15,35 @@
 
 # Quo
 
-[Quo is a free, open-source, zero-dependecy, client-side debugger and can be
-found here](https://github.com/Protoqol/Quo).
+> Quo is currently in beta, releases are only available as zip unless you built Quo yourself.
 
-Quo is a debugging utility to easily dump variables, the dumped variables will appear in this Quo client instead of the
+[Quo is a free, open-source, client-side debugger and can be found here](https://github.com/Protoqol/Quo).
+
+Quo is a debugging companion to help you debug dumped variables, the dumped variables will appear in this Quo client
+instead of the
 traditional way which is often tedious.
 
+## Features
+
+- See which variable was dumped (name or value)
+- Nested variables unfolding (thanks to symfony/var-dumper)
+
+![Quo](assets/preview.png)
+
+- Search dumped variables
+
+![Quo](assets/preview_search.png)
+
+## Install - only zip available for now.
+
+1. Head over to [the releases](https://github.com/Protoqol/Quo/releases)
+2. Look for the latest version
+3. Download the zip for your OS (quo-darwin-\*.zip for macOS, quo-linux-\*.zip for Linux, quo-win32-\*.zip for windows)
+4. Extract wherever, and run the Quo executable.
+
+- You need a companion package like [Quo-php](https://github.com/Protoqol/Quo-php) to send variables to Quo.
+- Default (unchangeable for now) hostname and port for Quo are 127.0.0.1:7312.
+
 ## Issues
 
 #### Issues, bugs and feature requests can be reported [here!](https://github.com/Protoqol/quo-php/issues/new/choose)

diff --git a/.github/assets/preview.png b/.github/assets/preview.png
diff --git a/.github/assets/preview_search.png b/.github/assets/preview_search.png
diff --git a/config/forge.config.js b/config/forge.config.js
@@ -3,52 +3,52 @@ const path = require("path");
 module.exports = {
     "packagerConfig": {},
     "makers"        : [
-        {
-            name  : "@electron-forge/maker-deb",
-            config: {
-                options: {
-                    "owner"             : "Protoqol",
-                    "maintainer"        : "Protoqol",
-                    "name"              : "Quo",
-                    "genericName"       : "Debugger",
-                    "productName"       : "Quo",
-                    "categories"        : ["Development"],
-                    "productDescription": "Quo is a debugging utility to easily dump variables, the dumped variables will appear in this Quo client instead of the traditional way which is often tedious.",
-                    "description"       : "Quo, debugging software with ease.",
-                    "icon"              : path.resolve(__dirname + "/build/ico/ico-quo.png"),
-                    "section"           : "devel",
-
-                },
-            },
-        },
-        {
-            name  : "@electron-forge/maker-dmg",
-            config: {
-                "name"                : "Quo",
-                "overwrite"           : true,
-                "additionalDMGOptions": {
-                    "title"   : "Quo installation",
-                    "icon"    : path.resolve(__dirname + "/build/ico/ico-quo.icns"),
-                    "contents": [
-                        {"x": 448, "y": 344, "type": "link", "path": "/Applications"},
-                        {"x": 192, "y": 344, "type": "file", "path": "Quo Client.app"},
-                    ],
-                },
-            },
-        },
-        {
-            name  : "@electron-forge/maker-squirrel",
-            config: {
-                "name"       : "quo",
-                "description": "Quo, debugging software with ease.",
-                "exe"        : "Quo.exe",
-                "iconUrl"    : path.resolve(__dirname + "/build/ico/ico-quo.ico"),
-                "setupExe"   : "quo-installer.exe",
-                "title"      : "Quo",
-                "productName": "Quo",
-
-            },
-        },
+        // {
+        //     name  : "@electron-forge/maker-deb",
+        //     config: {
+        //         options: {
+        //             "owner"             : "Protoqol",
+        //             "maintainer"        : "Protoqol",
+        //             "name"              : "Quo",
+        //             "genericName"       : "Debugger",
+        //             "productName"       : "Quo",
+        //             "categories"        : ["Development"],
+        //             "productDescription": "Quo is a debugging utility to easily dump variables, the dumped variables will appear in this Quo client instead of the traditional way which is often tedious.",
+        //             "description"       : "Quo, debugging software with ease.",
+        //             "icon"              : path.resolve(__dirname + "/build/ico/ico-quo.png"),
+        //             "section"           : "devel",
+        //
+        //         },
+        //     },
+        // },
+        // {
+        //     name  : "@electron-forge/maker-dmg",
+        //     config: {
+        //         "name"                : "Quo",
+        //         "overwrite"           : true,
+        //         "additionalDMGOptions": {
+        //             "title"   : "Quo installation",
+        //             "icon"    : path.resolve(__dirname + "/build/ico/ico-quo.icns"),
+        //             "contents": [
+        //                 {"x": 448, "y": 344, "type": "link", "path": "/Applications"},
+        //                 {"x": 192, "y": 344, "type": "file", "path": "Quo Client.app"},
+        //             ],
+        //         },
+        //     },
+        // },
+        // {
+        //     name  : "@electron-forge/maker-squirrel",
+        //     config: {
+        //         "name"       : "quo",
+        //         "description": "Quo, debugging software with ease.",
+        //         "exe"        : "Quo.exe",
+        //         "iconUrl"    : path.resolve(__dirname + "/build/ico/ico-quo.ico"),
+        //         "setupExe"   : "quo-installer.exe",
+        //         "title"      : "Quo",
+        //         "productName": "Quo",
+        //
+        //     },
+        // },
         {
             name: "@electron-forge/maker-zip",
         },