Updated ReadME and License

README.md

@@ -1 +1,72 @@
-# Upscayl
+<div align="center">
+
+# Upscayl 🆙
+
+#### Free and Open Source AI Image Upscaler
+
+<img src="https://j.gifs.com/lRPzxj.gif">
+
+**Upscayl is a cross-platform application built with the Linux-first philosophy. This means that we prioritize Linux builds over others but that doesn't mean we'll break things for other OSes :)**
+
+</div>
+
+# Installation 👨‍💻
+
+## Linux 🐧
+
+1. Go to [releases section](https://github.com/TGS963/upscayl/releases/latest)
+
+2. Download the `.AppImage` file.
+
+3. Right Click AppImage -> Go to Permissions tab -> Check allow file to execute and then double click the file to run Upscayl.
+
+You can also download the flatpak version and double click the flatpak file to install via Store but wait for the full release, we'll be pushing it to Flathub for easy access.
+
+## MacOS 🍎
+
+Coming soon...
+
+## Windows 🐌
+
+Coming soon...
+
+# Roadmap 🤫
+
+- Allow video upscaling
+- 2x, 3x upscaling modes
+- More models
+- Make the whole world use FOSS
+
+# Development 🛠
+
+```
+git clone https://github.com/TGS963/upscayl
+cd upscayl
+
+# INSTALL DEPENDENCIES
+npm install
+
+# RUN THE DEVELOPMENT SERVER LOCALLY
+npm run start
+
+# PACKAGE THE APP
+npm run dist
+
+# PUBLISH THE APP, MAKE SURE TO ADD GH_TOKEN= IN SHELL
+npm run publish-app
+```
+
+# Credits ❤
+
+- Real-ESRGAN for their wonderful research work.
+- Microsoft™ for their Fluent Emoji used as our logo.
+
+#
+
+<div align="center">
+
+Copyright © 2022 - **Upscayl**
+Made by Nayam Amarshe and TGS963\
+using 🖱 & ⌨
+
+</div>

package.json

@@ -3,6 +3,7 @@
   "private": true,
   "version": "1.1.1",
   "productName": "Upscayl",
+  "homepage": "https://github.com/TGS963/upscayl",
   "contributors": [
     {
       "name": "Nayam Amarshe",
@@ -15,7 +16,8 @@
       "url": "https://github.com/TGS963"
     }
   ],
-  "license": "GPLv2",
+  "email": "simplelogin-newsletter.j1zez@aleeas.com",
+  "license": "AGPL-3.0",
   "description": "Upscayl - Free and Open Source AI Image Upscaler",
   "keywords": [
     "AI",
@@ -33,12 +35,12 @@
     "start": "electron .",
     "build": "next build renderer && next export renderer",
     "pack-app": "npm run build && electron-builder --dir",
-    "dist": "npm run build && electron-builder",
+    "dist": "npm run build && DEBUG=* electron-builder",
     "publish-app": "npm run build && electron-builder -l --publish always"
   },
   "build": {
     "productName": "Upscayl",
-    "appId": "com.tgs963.upscayl",
+    "appId": "org.upscayl.app",
     "asar": true,
     "extraFiles": [
       {
@@ -54,7 +56,8 @@
         "github"
       ],
       "target": [
-        "AppImage"
+        "AppImage",
+        "flatpak"
       ],
       "asarUnpack": [
         "**/node_modules/sharp/**"