README update

2024-10-08 01:04:03 +11:00
parent c0b2255315
commit 6ea3f9186f
1 changed files with 12 additions and 1 deletions
@@ -1 +1,12 @@
-# Drop App
+# Drop App
+
+Drop app is the companion app for [Drop](https://github.com/Drop-OSS/drop). It uses a Tauri base with Nuxt 3 + TailwindCSS on top of it, so we can re-use components from the web UI.
+
+## Development
+
+Install dependencies with `yarn`
+
+Run the app in development with `yarn tauri dev`. NVIDIA users on Linux, use the environment variable in `.env`
+
+## Contributing
+Check the original Drop repo for contributing guidelines.