Draft of a proper readme and a license file

README.md

@@ -1,3 +1,60 @@
 # pds-dash
 
-Frontend with stats for your ATProto PDS
+a frontend dashboard with stats for your ATProto PDS.
+
+## setup
+
+### prerequisites
+
+- [Deno](https://deno.com/manual/getting_started/installation)
+
+### installing
+
+clone the repo, install dependencies using deno:
+
+```sh
+deno install
+```
+
+### development server
+
+local develompent server with hot reloading:
+
+```sh
+deno task dev
+```
+
+### building
+
+to build the optimized bundle run:
+
+```sh
+deno task build
+```
+
+the output will be in the `dist/` directory.
+
+## deploying
+
+we use our own CI/CD workflow at [`.forgejo/workflows/deploy.yaml`](.forgejo/workflows/deploy.yaml), but it boils down to building the project bundle and deploying it to a web server. it'll probably make more sense to host it on the same domain as your PDS, but it doesn't affect anything if you host it somewhere else.
+
+## configuring
+
+`config.ts` is the main configuration file, you can find more information in the file itself.
+
+## theming
+
+currently the only way to theme the app is to edit css in the components directly, glhf
+
+relevant files:
+
+- `src/App.svelte`
+- `src/app.css`
+- `src/lib/AccountComponent.svelte`
+- `src/lib/PostComponent.svelte`
+
+the favicon is located at `public/favicon.png`
+
+## License
+
+MIT