Updated documentation

.eslintrc.json

@@ -0,0 +1,18 @@
+{
+    "extends": [
+        "react-app",
+        "react-app/jest"
+    ],
+    "plugins": [
+        "react"
+    ],
+    "settings": {
+        "react": {
+            "version": "detect" // Automatically detects the React version from your project
+        }
+    },
+    "rules": {
+        "react/react-in-jsx-scope": "off", // React 17 and later does not require `React` in scope
+        "react/prop-types": "off" // Optional: Disable prop types if using TypeScript or TypeScript-like checks
+    }
+}

.prettierrc

@@ -0,0 +1,7 @@
+{
+  "singleQuote": true,
+  "semi": true,
+  "trailingComma": "all",
+  "printWidth": 80,
+  "tabWidth": 2
+}

README.md

@@ -1,2 +1,33 @@
 # karya-ui
-Browser based UI to interact with Karya Backend
+Browser based UI to interact with [Karya](https://github.com/Saumya-Bhatt/karya) the distributed task execution framework.
+
+## Screenshots
+
+### Scheduling Plans
+
+![Scheduling Jobs](./media/schedule_job.png)
+
+### List all Plans
+
+![View Jobs](./media/list_plans.png)
+
+### View Plan Summary
+
+![View Plan Summary](./media/plan_summary.png)
+
+## Quick Start
+
+1. Run the docker container using the following command:
+
+    ```shell
+    docker run -d --name karya-ui -p 5001:5000 karya-ui
+    ```
+
+2. Open the browser and navigate to `http://localhost:5001`
+3. On the login page, provide the URL where the Karya server is running and enter a username (if not already registered, a new user will be created)
+
+![Login Page](./media/signin.png)
+
+And you're good to go!
+
+> **Note**: Leave the URL fiel empty to use a stubbed client to test the UI