update readme

amananand20 · Oct 10, 2024 · 712aa54 · 712aa54
1 parent 793f541
commit 712aa54
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,44 @@
-# Connekt.dev
+# Route
 
-Connekt.dev is a minimalist platform for developers to showcase their projects, links and sync their GitHub activity.
+Route is a platform that allows users to easily connect and share their projects, skills, and resources in one centralized place.
+
+![Route Logo](https://i.imgur.com/dM2NQQe.png)
 
 ## Features
 
-- Sync GitHub activity
-- Display tech stack
-- Customizable profiles
+- Showcase your favorite links like Linktree
+- Showcase your Tech Stack with a cool design
+- Automatically show your Github stats
+- Shareable link at `https://route2.dev/yourusername`
+
+## Tech Stack
+
+- **FullStack Framework**: SvelteKit
+- **Styling**: Shadcn-Svelte && Tailwind
+- **Database**: PostgresQL (Prisma as ORM)
+
+## How to Contribute
+
+1. Clone the project
+
+```bash
+git clone https://github.com/s1lvax/route
+```
+
+2. Install dependencies
+
+```bash
+pnpm i
+```
+
+3. Run a Postgres instance (I recommend using Docker)
+
+```bash
+docker run --name your_postgres_container -e POSTGRES_USER=your_username -e POSTGRES_PASSWORD=your_password -e POSTGRES_DB=your_database -p 5432:5432 -d postgres
+```
+
+4. Update the `example.env` to `.env` and fill in your data
+5. Develop the change using a separate branch, either `bugfix/name` or `feature/name`
+6. Push your changes and open a Pull Request with details about your changes
+
+#### All Pull Requests are very appreciated :D
diff --git a/example.env b/example.env
@@ -0,0 +1,8 @@
+#Random 32 byte string (https://generate-secret.vercel.app/32)
+AUTH_SECRET=''
+
+#Github OAuth
+CLIENT_ID=''
+CLIENT_SECRET=''
+
+DATABASE_URL="postgresql://username:password@localhost:port/database_name?schema=public"
diff --git a/src/app.html b/src/app.html
@@ -11,7 +11,7 @@
 			href="https://fonts.googleapis.com/css2?family=Poppins:ital,wght@0,100;0,200;0,300;0,400;0,500;0,600;0,700;0,800;0,900;1,100;1,200;1,300;1,400;1,500;1,600;1,700;1,800;1,900&display=swap"
 			rel="stylesheet"
 		/>
-		<title>Connekt.dev</title>
+		<title>Route - Connect and Share Your Profile</title>
 		%sveltekit.head%
 	</head>
 	<body data-sveltekit-preload-data="hover">