Update README.md

Author: vimaltrydig

README.md

@@ -1,40 +1,47 @@
-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).
+# Next.js Azure Blob Storage file upload with stream
 
-## Getting Started
-
-First, run the development server:
-
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
-```
+This is a Next.js API route that facilitates file uploads from the client-side and stores them in Azure Blob Storage. It uses the `multer` library to handle multipart/form-data and streams files directly to a specified Azure Blob Storage container.
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+## Features
 
-You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
+- Upload multiple files at once.
+- Stream files directly from memory to Azure Blob Storage.
+- Environment variables for Azure account configuration.
+- Customizable file size and type constraints.
+- Progress tracking on file uploads (client-side feature).
 
-[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`.
+## Prerequisites
 
-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.
+Before you get started, make sure you have the following:
+- Node.js (v12 or higher recommended)
+- An Azure Storage account with access keys.
+- An Azure Blob Container created in your Storage account.
 
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
-
-## Learn More
+## Getting Started
 
-To learn more about Next.js, take a look at the following resources:
+These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
 
-- [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.
+### Installation
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+1. Clone the repository:
+```bash
+git clone https://github.com/your-github-username/your-repo-name.git
+cd file-uploader-api
+```
+2. Install NPM packages:
+```bash
+npm install
+```
+3. Create a `.env.local` file in the root of your project and populate with configurations from `.env.example`.
 
-## Deploy on Vercel
+### Running the project
+After installation, you can start the development server:
+```bash
+npm run dev
+```
+Open `http://localhost:3000` with your browser to see the file uploader component where you can upload files to azure blob storage.
 
-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.
+### API Reference
+#### POST /api/upload
+Accepts a multipart/form-data request with a field named files which should contain the files to be uploaded.
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.