Update README.md

README.md

@@ -1,38 +1,45 @@
-# create-svelte
+# Cathode [![status-badge](https://ci.greenboi.me/api/badges/emerald/cathode/status.svg)](https://ci.greenboi.me/emerald/cathode)
+a small app for PNG tubing. Think Veadotube-mini but completely FOSS.
 
-Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte).
+Built with Tauri and Svelte.
 
-## Creating a project
+## Installation
 
-If you're seeing this, you've probably already done this step. Congrats!
+### Web app
+If you'd like to try Cathode without installing, or are on a platform that isn't supported, you can try the web version over at https://app.cathode.tube
 
+It should work on any up to date browser and should offer all of the same features as the desktop version with little performance tradeoff.
+
+### Packages
+There are a few prebuilt packages available [here](https://codeberg.org/anactualemerald/-/packages/generic/cathode-tube/) for the latest stable release. Debian derived distros will want the `.deb` file, and Fedora users will want the `.rpm` file. Download the correct file and install it with your package manager.
+
+Alternatively, download the AppImage, which should work on any glibc linux distro at the cost of being a considerably larger file. Once you download the `.AppImage` file, give it execution permissions (eg: `chmod +x cathode-tube.AppImage`) and run it like a command or script.
+
+### Building from source
+#### Prerequisites
+In order to build from source you will need a few things to get started
+- Nodejs/yarn (I recommend using [nvm](https://github.com/nvm-sh/nvm) for this)
+- [Rust](https://rustup.rs/)
+- Tauri's [development dependencies](https://tauri.app/v1/guides/getting-started/prerequisites#installing)
+#### Building
+Once all of these are installed, clone the repo and run 
 ```bash
-# create a new project in the current directory
-npm create svelte@latest
+yarn install --frozen-lockfile
+```
+This will install everything needed to build the frontend, as well as the tauri cli. Building the project itself is then as simple as
+```bash
+yarn tauri build
+```
+This will build the frontend and backend, and bundle the `.deb` and `.AppImage` packages, found in `src-tauri/target/release/bundle`. 
 
-# create a new project in my-app
-npm create svelte@latest my-app
+The binary itself (at `src-tauri/target/release/cathode-tube`) is all that is needed to run the program, so if neither bundle works for you simply copy the executable to somewhere in your path, or run 
+```
+cargo install --path src-tauri 
 ```
 
-## Developing
-
-Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
-
-```bash
-npm run dev
-
-# or start the server and open the app in a new browser tab
-npm run dev -- --open
+#### Just
+If you have the [just](https://github.com/casey/just) command runner installed, as well as the other prerequisites, then you can run
 ```
-
-## Building
-
-To create a production version of your app:
-
-```bash
-npm run build
+just install 
 ```
-
-You can preview the production build with `npm run preview`.
-
-> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.
+Which will build the project and install it to `/usr/bin`, along with the `.desktop` file and icons