From 073bf65094e191b3da1232f1c501ad47516b3c52 Mon Sep 17 00:00:00 2001
From: Yuri Tatishchev <itatishch@gmail.com>
Date: Mon, 3 Mar 2025 15:32:31 -0800
Subject: [PATCH] update readme

---
 .idea/{vpgen-sv5.iml => vpgen.iml} |  0
 README.md                          | 54 +++++++++++-------------------
 bun.lock                           |  2 +-
 package.json                       |  2 +-
 4 files changed, 22 insertions(+), 36 deletions(-)
 rename .idea/{vpgen-sv5.iml => vpgen.iml} (100%)

diff --git a/.idea/vpgen-sv5.iml b/.idea/vpgen.iml
similarity index 100%
rename from .idea/vpgen-sv5.iml
rename to .idea/vpgen.iml
diff --git a/README.md b/README.md
index 0d62b61..85a35be 100644
--- a/README.md
+++ b/README.md
@@ -1,40 +1,26 @@
-# sv
+# VPGen
 
-Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli).
+One-click WireGuard config generator, work in progress.
 
-## Creating a project
+## Why?
 
-If you're seeing this, you've probably already done this step. Congrats!
+Make it easier to share VPN access with friends/family,
+making use of (my) existing networking infrastructure.
 
-```bash
-# create a new project in the current directory
-npx sv create
+## How?
 
-# create a new project in my-app
-npx sv create my-app
+Currently, the supported backend is [OPNsense](https://opnsense.org/).
+VPGen just creates WireGuard clients on the configured interface via the OPNsense API.
+
+Future plans include supporting other API backends, e.g. [Netmaker](https://github.com/gravitl/netmaker)
+
+## Development
+
+Development uses bun.
+
+For example .env settings, see [.env.example](.env.example)
+
+```shell
+bun install
+bun run dev
 ```
-
-## 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
-```
-
-## Building
-
-To create a production version of your app:
-
-```bash
-npm run build
-```
-
-You can preview the production build with `npm run preview`.
-
-> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.
-
-When deploying, set `ORIGIN` to the URL of your site to prevent cross-site request errors.
diff --git a/bun.lock b/bun.lock
index 7a53616..f889064 100644
--- a/bun.lock
+++ b/bun.lock
@@ -2,7 +2,7 @@
   "lockfileVersion": 1,
   "workspaces": {
     "": {
-      "name": "vpgen-sv5",
+      "name": "vpgen",
       "dependencies": {
         "@libsql/client": "^0.14.0",
         "drizzle-kit": "^0.30.4",
diff --git a/package.json b/package.json
index 6590ed7..7083285 100644
--- a/package.json
+++ b/package.json
@@ -1,5 +1,5 @@
 {
-	"name": "vpgen-sv5",
+	"name": "vpgen",
 	"version": "0.0.1",
 	"type": "module",
 	"scripts": {