Updated: readme.md

README.md

@@ -1 +1,36 @@
-# plaidware-wms-core
+# Plaidware WMS - Core
+
+This project contains the core module for Plaidware's Warehouse Management System (WMS)
+
+## Environment Variables
+
+To run this project, you will need to add the following environment variables to your .env file
+
+`API_PORT` - The port at which the application would listen for requests
+
+`MONGODB_URI` - The MongoDB connection string
+
+## Run Locally
+
+Clone the project and go to the project directory. Install dependencies and run:
+
+```bash
+  cd <project folder>
+  npm install
+```
+
+Start the server
+
+```bash
+  npm run dev
+```
+
+## Deployment
+
+To deploy this project, clone the project and run:
+
+```bash
+  cd <project folder>
+  npm install
+  npm start
+```