Merge pull request #21 from imSyntn/readme-change

Readme updated

README.md

@@ -1,20 +1,25 @@
-TWEETER : a social media website which provides users with the feature to grow their social connections, raise any issue or get updated of what's happening around
-          Users can join TWEETER by simply creating their account, having an updated profile, and can create any tweets. Tweeter also provides you the feature to have the                 experience of real-time chats with your connections.
-
-FEATURES :
-1. SignIn/ SignUp or Google Authentication
-2. Create, Share, Reply, Retweet, Like or Bookmark any tweet
-3. Notifications section to have all new notification
-4. Bookmarks section to see your bookmarks
-5. Real time chat application using web-sockets.
-6. Profile page
-
-TECH-STACKS :
-Frontend: HTML, CSS, JS, ReactJS, Redux
-Backend: NodeJS, ExpressJS, PostgreSql
-Designing: Figma
-
-IMAGES :
+# TWEETER
+
+TWEETER is a social media website which provides users with the feature to grow their social connections, raise any issue or get updated of what's happening around. Users can join Tweeter by simply creating their account, having an updated profile, and can create any tweets. Tweeter also provides you the feature to have the experience of real-time chats with your connections.
+
+## Features
+
+- **User Authentication:** Secure user registration and login system to protect user data.
+- **Tweet Creation:** Write and post tweets through an intuitive interface.
+- **Interactions:** Like, retweet, and reply to tweets to engage with other users.
+- **Follow and Unfollow:** Build a network by following and unfollowing other users.
+- **Real-time Updates:** Stay up-to-date with real-time notifications for new tweets and interactions.
+- **User Profiles:** Customize your profile with a profile picture and bio.
+- **Search Functionality:** Easily find tweets and users with a robust search feature.
+
+## Tech-Stacks
+
+- **Frontend:** HTML, CSS, JS, ReactJS, Redux
+- **Backend:** NodeJS, ExpressJS, PostgreSql
+- **Designing:** Figma
+
+## IMAGES :
+
 ![tweeter login](https://user-images.githubusercontent.com/104606182/216806589-f8b0da49-5e79-4acf-89b3-1bd48c2735d4.PNG)
 ![tweeter 2](https://user-images.githubusercontent.com/104606182/216806632-5243785a-56eb-49eb-a251-c9c2736dfb2f.PNG)
 ![tweeter 1](https://user-images.githubusercontent.com/104606182/216806660-7ce5e45a-0780-43b0-b7d6-d186693b0746.PNG)
@@ -24,3 +29,51 @@ IMAGES :
 ![tweeter 8](https://user-images.githubusercontent.com/104606182/216806666-0f982288-6447-4628-9f29-ffd29946e9f7.PNG)
 ![tweeter 9](https://user-images.githubusercontent.com/104606182/216806667-b4b4940d-3fba-45f1-87b3-514fbdd6338a.PNG)
 
+## Getting Started
+
+Follow these instructions to get Tweeter Frontend up and running on your local machine.
+
+### Prerequisites
+
+Before you begin, ensure you have the following installed:
+
+- **Node.js:** Download and install Node.js from [here](https://nodejs.org/).
+
+### Installation
+
+1. Clone the repository:
+
+   ```bash
+   git clone https://github.com/[yourusername]/tweeter-frontend.git
+
+2. Navigate to the project directory:
+
+   ```bash
+   cd tweeter-frontend
+
+3. Install dependencies:
+
+   ```bash
+   npm install
+
+### Usage
+
+1. Start the development server:
+   ```bash
+   npm start
+2. Open your web browser and navigate to http://localhost:3000.
+3. Create an account, log in, and start tweeting!
+
+### Contributing
+
+We welcome contributions from the community. To contribute to Tweeter Frontend, follow these steps:
+
+1. Fork the project on GitHub.
+2. Create a new branch with a descriptive name for your feature or fix.
+3. Make your changes and ensure that your code follows best practices.
+4. Test your changes thoroughly.
+5. Create a pull request (PR) to the main repository, explaining the changes you made and why they are valuable.
+
+### Acknowledgments
+
+We would like to thank the open-source community and the developers of the technologies used in this project for their valuable contributions.