Update readme, add license

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Nicola Spadari<https://github.com/NicolaSpadari>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,26 +1,78 @@
 <p align="center">
-    <img width="150" src="./src/public/logo.svg" alt="logo">
+    <img width="150" src="./src/assets/logo.svg" alt="logo">
 </p>
 <h1 align="center">NUXTOR</h1>
 <hr />
-
 <p align="center">
-**⚠️ `nuxtor` is still a WIP ⚠️**
+A spiritual successor of <a href="https://github.com/NicolaSpadari/vitauri">ViTauri</a> made with <a href="https://nuxt.com">Nuxt 3</a> and <a href="https://tauri.app">Tauri 2</a>
+<br>
+Build super fast desktop applications!
 </p>
 
-## Usage
+**⚠️ `nuxtor` is still a WIP ⚠️**
 
-Clone to local:
-```sh
-$ npx degit NicolaSpadari/nuxtor
-```
+<img src="https://img.shields.io/github/license/NicolaSpadari/nuxtor" />
+
+<div align="center">
+<img src="./screenshot.png">
+</div>
+
+<br><br>
+
+## Technologies run-down
+
+- Nuxt 3
+- Tauri 2
+- UnoCSS
+- Typescript
+- ESLint
+- Auto imports (for Tauri api too!)
+
+## Functionalities
+
+- Run shell commands from the app
+- Send custom notifications to the client
+- Display OS related informations
+- Support catch-all route
+
+## Setup
+
+  - This project enforces [pnpm](https://pnpm.io). In order to use another package manager you need to update `package.json` and `tauri.config.js`
+  - Before running this app, you need to configure your environment with Rust. Take a look at the [Tauri docs](https://v2.tauri.app/start/prerequisites).
+  - The frontend runs on the usual port `3000` of Nuxt, the Tauri server uses the port `3001`. This settings are customizable in the `nuxt.config.ts` and `tauri.config.js`.
+  - Once ready, follow these commands:
 
-Install dependencies:
   ```sh
+  # use this template
+  $ npx degit NicolaSpadari/nuxtor my-nuxtor-app
+
+  # go into the folder
+  $ cd my-nuxtor-app
+
+  # install dependencies
   $ pnpm install
+
+  # start the project
+  $ pnpm run tauri:dev
   ```
 
-Run project:
+  This will run the Nuxt frontend and will launch the Tauri window.
+
+## Build
+
   ```sh
-$ pnpm run dev
+  $ pnpm run tauri:build
   ```
+
+This command will generate the Nuxt static output and bundle the project under `src-tauri/target`.
+
+## Notes
+
+- As the documentation shows, the Nuxt SSr must be disabled in order for Tauri to act as the backend. Still, all Nuxt capabilities are still here.
+- Tauri v2 is still in beta. Some things might not work, or present some bugs.
+- Tauri v2 brings some big refactors, such as packages names and permission management. New permissions have to be granted under `src-tauri/capabilities/main.json`
+- Tauri js functions are auto imported as-is with the help of a custom module. If another Tauri plugin is added, then the module has to be updated to support auto imports under `src/modules/tauri.ts`
+
+## License
+
+MIT License © 2024-PRESENT [NicolaSpadari](https://github.com/NicolaSpadari)

package.json

@@ -6,6 +6,7 @@
 	"packageManager": "pnpm@9.3.0",
 	"description": "Starter template for Nuxt 3 with Tauri",
 	"author": "Nicola Spadari",
+	"license": "MIT",
 	"engines": {
 		"node": ">=20"
 	},