Instructions to use Docker image.

README.md

@@ -1,19 +1,22 @@
 # resumption
 
-Dockerized microservice to extract information from PDF resumes of infinite kind and transform it into uniform JSON structure to be used for further automation.
+Dockerized microservice to extract information from PDF resumes of infinite kind and transform it into uniform [JSON](https://www.json.org/json-en.html) structure to be used for further automation.
 
-## Development
+## Usage
 
-Run below commands in project folder:
+Firstly, download and create a `config.ini` from the published example using below command:
 
 ```shell
-# create app config
-cp config.dist.ini config.ini
+wget -O config.ini https://raw.githubusercontent.com/vaibhavpandeyvpz/resumption/main/config.dist.ini
+```
 
-# update values in config.ini e.g., openai.* ones
+Then run the [Docker](https://www.docker.com/) container as below:
 
-# start the services
-docker compose up -d
+```shell
+docker run -it --rm \
+  -p "8000:8000" \
+  -v ./config.ini:/app/config.ini \
+  ghcr.io/vaibhavpandeyvpz/resumption:latest
 ```
 
 Server should be up & running on [127.0.0.1:8000](http://127.0.0.1:8000/).
@@ -24,3 +27,19 @@ curl -X GET \
   -H "accept: application/json" \
   http://127.0.0.1:8000/
 ```
+
+To test resume processing, refer to the include [Postman](https://www.postman.com/) collection i.e., [Resumption.postman_collection.json](Resumption.postman_collection.json).
+
+## Development
+
+Clone the project and run below commands in project folder:
+
+```shell
+# create app config
+cp config.dist.ini config.ini
+
+# update values in config.ini e.g., openai.*
+
+# start the services
+docker compose up -d
+```

Resumption.postman_collection.json

@@ -0,0 +1,58 @@
+{
+  "info": {
+    "_postman_id": "1ff61a1f-46a9-42aa-a93d-ca8274c0e057",
+    "name": "Resumption",
+    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
+    "_exporter_id": "16000625"
+  },
+  "item": [
+    {
+      "name": "Process",
+      "request": {
+        "method": "POST",
+        "header": [],
+        "body": {
+          "mode": "formdata",
+          "formdata": [
+            {
+              "key": "resume",
+              "type": "file",
+              "src": []
+            }
+          ]
+        },
+        "url": {
+          "raw": "{{BaseUrl}}/process",
+          "host": ["{{BaseUrl}}"],
+          "path": ["process"]
+        }
+      },
+      "response": []
+    }
+  ],
+  "event": [
+    {
+      "listen": "prerequest",
+      "script": {
+        "type": "text/javascript",
+        "packages": {},
+        "exec": [""]
+      }
+    },
+    {
+      "listen": "test",
+      "script": {
+        "type": "text/javascript",
+        "packages": {},
+        "exec": [""]
+      }
+    }
+  ],
+  "variable": [
+    {
+      "key": "BaseUrl",
+      "value": "http://127.0.0.1:8000",
+      "type": "string"
+    }
+  ]
+}

app/schema.py

@@ -44,7 +44,7 @@
         },
         "links": {
             "type": "array",
-            "description": "List of URLs or links (website, social media etc.) mentioned by the candidate.",
+            "description": "List of valid URLs (website, social media etc.) mentioned by the candidate.",
             "items": {"type": "string"},
         },
         "qualifications": {