From 32992710a2c901aa8b39a7ae3cdef3e341936c8a Mon Sep 17 00:00:00 2001
From: night0721 <77528305+night0721@users.noreply.github.com.>
Date: Wed, 1 Nov 2023 23:43:26 +0000
Subject: [PATCH] fix typos in readme and add env

---
 .env.example |  3 +++
 README.md    | 37 +++++++++----------------------------
 2 files changed, 12 insertions(+), 28 deletions(-)
 create mode 100644 .env.example

diff --git a/.env.example b/.env.example
new file mode 100644
index 0000000..56f3baa
--- /dev/null
+++ b/.env.example
@@ -0,0 +1,3 @@
+DISCORD_ID=
+DISCORD_SECRET=
+DATABASE_URL=
diff --git a/README.md b/README.md
index 6b4418b..4d45e88 100644
--- a/README.md
+++ b/README.md
@@ -1,42 +1,22 @@
 # NYX Dashboard
 
 This project is dashboard for its parent project, [NYX](https://github.com/night0721/cath.exe)
-# Featuers
+
+# Features
 
 - Login
 - Control Panel
 
-
 ## Run Locally
 
-Clone the project
-
 ```bash
-  git clone https://github.com/night0721/nyx-dashboard.git
+  git clone https://github.com/night0721/nyx-dashboard.git # clone repository
+  cd nyx-dashboard # go to project directory
+  npm install # install dependencies
 ```
+Then edit environment variables at .env.example, also change filename to .env
 
-Go to the project directory
-
-```bash
-  cd nyx-dashboard
-```
-
-Install dependencies
-
-```bash
-  npm install
-```
-
-Configure environment variables
-
-.env example
-```
-  DISCORD_ID=
-  DISCORD_SECRET=
-  DATABASE_URL=
-```
-
-Start the server
+Last, start the server
 
 ```bash
   npm run dev
@@ -44,7 +24,8 @@ Start the server
 
 ## License
 
-This project licensed under the GNU Public LICENSE v3.0. See [LICENSE](https://github.com/night0721/nyx-dashboard) for more information.
+This project licensed under the GNU Public License v3.0. See [LICENSE](https://github.com/night0721/nyx-dashboard) for more information.
+
 ## Authors
 
 - [@chunchunmaru](https://www.github.com/https://github.com/chunchunmaru)