From d08acd32d5c5a8eb1818e2d7af72e81dfd164f8c Mon Sep 17 00:00:00 2001
From: dess <dess@kyoline.dev>
Date: Sun, 21 Apr 2024 21:07:53 -0400
Subject: [PATCH] chore: better readme + package.json

---
 README.md    | 23 +++++++++++++++++++++--
 package.json |  6 +++---
 2 files changed, 24 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index bd17643..0e1a975 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,21 @@
-# typescript-base
-Base TypeScript template to use
+<h1 align="center">NextNet</h1>
+
+<p align="center">
+   <a href="https://builtwithnix.org"><img src="https://builtwithnix.org/badge.svg" alt="built with nix" height="20"/></a>
+   <img src="https://img.shields.io/github/license/greysoh/nextnet" alt="License Badge"/>
+</p>
+
+<br>
+
+**NextNet is a dashboard to manage portforwarding technologies.**
+
+<h2 align="center">Local Development</h2>
+
+> [!NOTE]
+> Using [nix](https://builtwithnix.org) is recommended. If you're not using Nix, install PostgreSQL, Node.JS, and `lsof`.
+
+1. First, check if you have a working Nix environment if you're using Nix.
+
+2. Run `nix-shell`, or alternatively `source init.sh` if you're not using Nix.
+3. After that, run the project in development mode: `npm run dev`.
+4. If you want to explore your database, run `npx prisma studio` to open the database editor.
\ No newline at end of file
diff --git a/package.json b/package.json
index 1e0ece9..a76a084 100644
--- a/package.json
+++ b/package.json
@@ -1,7 +1,7 @@
 {
-  "name": "typescript-base",
-  "version": "1.0.0",
-  "description": "Base TypeScript template to use",
+  "name": "nextnet",
+  "version": "0.1.0",
+  "description": "Yet another dashboard to manage portforwarding technologies",
   "main": "index.js",
   "type": "module",
   "scripts": {