From 9eef2edc7786a83dd9c852325b2a698be5ecb1b3 Mon Sep 17 00:00:00 2001
From: Joywinbarboza <joywinbarboza420@gmail.com>
Date: Thu, 7 Dec 2023 19:35:32 +0530
Subject: [PATCH] Improved the readme file

---
 README.md           | 61 +++++++++++++++++++++++++++------------------
 api/.env.example    |  4 ---
 client/.env.example |  3 ---
 3 files changed, 37 insertions(+), 31 deletions(-)
 delete mode 100644 api/.env.example
 delete mode 100644 client/.env.example

diff --git a/README.md b/README.md
index bce0877..cab8f51 100644
--- a/README.md
+++ b/README.md
@@ -1,28 +1,41 @@
+# Canvas Tile Placement Website
+
+Welcome to the Canvas Tile Placement website! This platform allows users to contribute to a shared canvas by placing colored tiles. Whether you choose to register or continue as a guest, you can make your mark on the canvas with the color of your choice.
+
+## Getting Started
+
+### Registration
+
+- To contribute to the canvas, you have the option to **register** or continue as a **guest**.
+- If you choose to register, follow the on-screen instructions to create an account.
+
+### Guest Contribution
+
+- If you prefer not to register, simply click on "**Continue as Guest**" on the homepage.
+
+## Contributing to the Canvas
+
+1. After registration or selecting the guest option, you will be directed to the canvas contribution page.
+2. The canvas provides a range of colors for you to choose from.
+3. Select your preferred color from the **palette**.
+
+## Placing a Tile
+
+- Click on any tile within the canvas to place your selected color.
+- The canvas is shared among all users, so your contribution will be visible to everyone.
+
+## Features
+
+- **User-Friendly Interface:** The website provides an intuitive interface for seamless navigation.
+- **Color Palette:** A diverse range of colors is available for users to choose from.
+- **Shared Canvas:** All users contribute to the same canvas, creating a collaborative and dynamic art piece.
+
 # Tiles
 
 Inspired by `r/place`, Idea by [Fawaz](https://github.com/fauwara) brought to you by [Deveesh Shetty](https://github.com/Deveesh-Shetty). Collaborate in the canvas, unleash your creativity, and enjoy!
 
-Checkout live - [placetile.vercel.app](https://placetile.vercel.app) hosted using Vercel and Render
-
-## Set the project locally
-- Fork and Clone the project
-- This project uses pnpm as a package manager, if you don't have it install it using
-```bash
-npm install -g pnpm
-```
-- Inside both the `client` and  `api/` folder copy `.env.example` to `.env` and fill the required fields.
-- Install the dependencies on the client side and run the frontend server
-```bash
-cd client/
-pnpm i
-pnpm run dev
-```
-- Open a new terminal, and install dependencies and run the backend server
-```
-cd api/
-pnpm i
-pnpm run dev
-```
-- You can now run the project locally and make changes 🥳
-
-![Tile Canvas](https://github.com/Deveesh-Shetty/tiles/assets/89470104/cff6b7b0-f107-411f-a22a-d69a56c776df)
+## Live Demo
+
+Checkout live - [placetile.vercel.app](https://placetile.vercel.app)
+
+Feel free to explore, contribute, and be part of the collaborative canvas!
diff --git a/api/.env.example b/api/.env.example
deleted file mode 100644
index 16d88a6..0000000
--- a/api/.env.example
+++ /dev/null
@@ -1,4 +0,0 @@
-PORT=5000
-MONGO_URI="mongodb_uri"
-JWT_SECRET="A_SECRET_STRING"
-NODE_ENV="development"
\ No newline at end of file
diff --git a/client/.env.example b/client/.env.example
deleted file mode 100644
index e8e5acd..0000000
--- a/client/.env.example
+++ /dev/null
@@ -1,3 +0,0 @@
-# Copy this to .env file
-
-NEXT_PUBLIC_SERVER_URL=http://localhost:5000