From 3ce69bc3bf189c89d41c05f84d36cf7e0d1fff58 Mon Sep 17 00:00:00 2001
From: poorna prakash sr <srprakash016@gmail.com>
Date: Thu, 15 Jun 2023 22:31:13 +0530
Subject: [PATCH] UPDATED README.md

---
 README.md | 50 +++++++++++++++++++++++++++-----------------------
 1 file changed, 27 insertions(+), 23 deletions(-)

diff --git a/README.md b/README.md
index 965a122..58b0e33 100644
--- a/README.md
+++ b/README.md
@@ -1,38 +1,42 @@
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+# PackagePlus
 
-## Getting Started
+PackagePlus is an open-source web application that allows users to upload their `package.json` files and compare versions, licenses, and security scores of the packages listed in the file
 
-First, run the development server:
+## Features
 
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-```
+- Upload `package.json` files and analyze package details.
+- Compare package versions to identify outdated dependencies.
+- Verify license compatibility and highlight any potential issues.
+- Calculate security scores based on vulnerability databases.
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+## Installation
 
-You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
+To run PackagePlus locally, follow these steps:
 
-[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`.
+- Clone the repository: git clone https://github.com/poorna-prakash-sr/packageplus
+- Navigate to the project directory: `cd PackagePlus`
+- Configure the environment variables: `cp .env.example .env`
+- Install dependencies: `yarn`
+- Start the application: `yarn api && yarn dev`
+- Access the application in your browser at http://localhost:3000
 
-The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
+### Contributors
 
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
+Contributing
+PackagePlus is an open-source project, and contributions are welcome! If you would like to contribute, please follow these steps:
 
-## Learn More
+1. Fork the PackagePlus repository on GitHub.
 
-To learn more about Next.js, take a look at the following resources:
+2. Clone your forked repository to your local machine.
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+3. Make the desired changes or add new features to the project.
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+4. Test your changes thoroughly to ensure they do not introduce any bugs or issues.
 
-## Deploy on Vercel
+5. Commit and push your changes to your forked repository.
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+6. Submit a pull request from your forked repository to the main PackagePlus repository.
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+### License
+
+PackagePlus is released under the _MIT License_. You can find the full license text in the LICENSE file.