From 32f6f32141b250b8df847799e8e50460799496b6 Mon Sep 17 00:00:00 2001 From: UltraLionFr Date: Wed, 20 Aug 2025 22:59:20 +0200 Subject: [PATCH] docs: add project README --- README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 53 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index dd0afd7..210eb79 100644 --- a/README.md +++ b/README.md @@ -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**. + +--- \ No newline at end of file