docs: add project README

2025-08-20 22:59:20 +02:00
parent 586c1a9720
commit 32f6f32141
1 changed files with 53 additions and 2 deletions
@@ -1,2 +1,53 @@
-# NASG
-A simple and secure generator for NEXTAUTH_SECRET values in Next.js applications.
+# 🔐 Next Auth Secret Generator
+
+A lightweight tool to generate **cryptographically secure secrets** for your Next.js apps.  
+All secrets are generated **locally in your browser** – nothing is stored or transmitted.
+
+---
+
+## ✨ Features
+- Generate 32-byte **Base64 encoded** secrets.
+- Copy the secret directly or as a full `.env` line.
+- Smooth animations with **Framer Motion**.
+
+---
+
+## 🚀 Getting Started
+
+### 1. Clone the repo
+```bash
+git clone https://github.com/ultralion/nasg.git
+cd nasg
+````
+
+### 2. Install dependencies
+
+```bash
+pnpm install
+```
+
+### 3. Run the development server
+
+```bash
+pnpm dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) to see it in action.
+
+---
+
+## 🛠️ Tech Stack
+
+* [Next.js 15](https://nextjs.org/)
+* [React 19](https://react.dev/)
+* [Tailwind CSS 4](https://tailwindcss.com/)
+* [Framer Motion](https://www.framer.com/motion/)
+* [Lucide Icons](https://lucide.dev/)
+
+---
+
+## 📜 License
+
+This project is licensed under the **MIT License**.
+
+---