Update README.md

README.md

@@ -1,59 +1,70 @@
-# Recipe Web App
-This is a web application that allows users to search for, save and share their favorite recipes. The app is built using the MERN (MongoDB, Express, React, Node.js) technology stack.
-## Table of Contents
-
-- [Recipe Web App](#Recipe-Web-App)
-  - [Table of Contents](#table-of-contents)
-  - [Features](#features)
-  - [Installation](#installation)
-  - [Usage](#usage)
-  - [API Endpoints](#api-endpoints)
-  - [Technologies Used](#technologies-used)
-  - [Contributors](#contributors)
-  - [License](#license)
+# React Recipe App
+
+The React Recipe App is a user-friendly and feature-rich application designed to simplify your culinary adventures. Whether you're an experienced chef or just getting started in the kitchen, this app will be your trusty companion in the world of cooking. It leverages the power of React, styled components, and the Spoonacular API to provide you with a seamless and enjoyable recipe browsing and cooking experience.
 
 ## Features
-Search for recipes based on keyword, ingredients or cuisine.
-View detailed recipe information including ingredients, directions, cooking time, and serving size.
-Save favorite recipes to a personal collection for easy access.
-Share recipes with friends and family via social media or email.
-Rate and review recipes.
-Create a shopping list based on selected recipes.
-User authentication and authorization for secure access to personal collections and reviews.
-
-## Installation
-To install and run the application locally, follow these steps:
-
-Clone the repository.
-Install the necessary dependencies by running npm install in the root directory and npm install in the client directory.
-Create a .env file in the root directory and add your MongoDB connection string and JWT secret key. For example:
-makefile
-MONGO_URI=<your-mongodb-connection-string>
-JWT_SECRET=<your-secret-key>
-Start the server by running npm run server in the root directory.
-Start the client by running npm start in the client directory.
-Open your browser and go to http://localhost:3000 to view the application.
-## API Endpoints
-The application includes the following API endpoints:
-
-GET /api/recipes - returns a list of all recipes.
-GET /api/recipes/:id - returns details for a specific recipe.
-POST /api/recipes - creates a new recipe.
-PUT /api/recipes/:id - updates an existing recipe.
-DELETE /api/recipes/:id - deletes a recipe.
-POST /api/users/register - creates a new user.
-POST /api/users/login - logs in a user and returns a JWT token.
-GET /api/users/profile - returns user profile information.
+
+- **Recipe Search**: Easily find the perfect recipe for any occasion by searching through a vast collection of dishes. Whether you're craving a hearty dinner, a quick snack, or a special dessert, our app has you covered.
+
+- **Detailed Information**: Each recipe comes with a wealth of information, including a list of ingredients, step-by-step cooking instructions, and nutritional facts. You'll have everything you need to create delicious meals at your fingertips.
+
+- **Save Favorites**: Keep track of your favorite recipes by saving them to your profile. No more flipping through cookbooks or searching through bookmarks; your go-to recipes are just a click away.
+
+- **User-Friendly Interface**: Our intuitive interface makes it easy to navigate and explore recipes, so you can spend less time searching and more time cooking.
+
+## Getting Started
+
+To get started with the React Recipe App, follow these simple steps:
+
+1. Clone this repository to your local machine:
+
+   ```
+   git clone https://github.com/mostlyali07/Recipe-Web-App.git
+   ```
+
+2. Navigate to the project directory:
+
+   ```
+   cd Recipe-Web-App
+   ```
+
+3. Install the required dependencies:
+
+   ```
+   npm install
+   ```
+
+4. Get your API key from [Spoonacular](https://spoonacular.com/food-api/console) and replace `YOUR_API_KEY` in the `.env` file with your actual API key.
+
+5. Start the development server:
+
+   ```
+   npm start
+   ```
+
+6. Open your web browser and visit `http://localhost:3000` to start using the app.
+
 ## Technologies Used
-- MongoDB - document-oriented database used for storing recipe and user data.
-- Express - web application framework used for building the server-side API.
-- React - JavaScript library used for building the client-side user interface.
-- Node.js - JavaScript runtime used for running the server-side API.
-- Bootstrap - CSS framework used for styling the application.
-- JWT - JSON Web Tokens used for user authentication and authorization.
 
-## Contributors
-Ali Rehan - [Github's Account](https://github.com/mostlyali07/)
+- React
+- Styled Components
+- Spoonacular API
+
+## Contributing
+
+We welcome contributions from the open-source community. If you'd like to enhance the app or report any issues, please check out our [contribution guidelines](CONTRIBUTING.md).
 
 ## License
-This project is licensed under the MIT License - see the LICENSE file for details.
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Acknowledgments
+
+- Special thanks to the Spoonacular team for providing the amazing API that powers this app.
+- We appreciate the open-source community for their valuable contributions and feedback.
+
+## Contact
+
+If you have any questions, suggestions, or just want to say hello, feel free to reach out to us at [[email protected]](mailto:[email protected]).
+
+Happy cooking! 🍽️👩‍🍳👨‍🍳