Readme file update

Author: Shreyas Nayak

README.md

@@ -1,86 +1,102 @@
 # NodeJS-FAAS
-This project aims to achieve something similar to Function as a Service (FaaS) without the overhead of Kubernetes, with extremely low infrastructure requirements.
 
-# Why NodeJS-FAAS? Why not any other FaaS?
-In today's era, event-driven microservice-based architecture is becoming increasingly popular. Using FaaS, you can trigger any code based on events. However, when you host FaaS in a Kubernetes cluster, you also have to consider the cost per function. NodeJS-FaaS is not intended to replace options such as OpenFaaS. Instead, NodeJS-FaaS offers an extremely lightweight lambda function solution.
+This project aims to provide a Function as a Service (FaaS) solution with minimal infrastructure requirements, avoiding the overhead of Kubernetes.
 
-# How does it work?
-NodeJS-FAAS utilizes the built-in Node.js VM module to execute the code.
+## Why Choose NodeJS-FAAS?
+
+In the modern era, event-driven, microservice-based architecture is gaining popularity. FaaS allows you to trigger code execution based on events. However, hosting FaaS on a Kubernetes cluster can be costly. NodeJS-FAAS offers a lightweight alternative, providing an efficient lambda function solution without the need for Kubernetes. It is not intended to replace solutions like OpenFaaS but to offer a simpler, more resource-efficient option.
+
+## How It Works
+
+NodeJS-FAAS uses the built-in Node.js VM module to execute code.
+
+## Setup Instructions
 
-# How to set up
 You can set up NodeJS-FAAS using Docker or Containerd.
 
-Pull using Docker:
+### Using Docker
 
-```
-docker pull shreyasnayak21/nodejs-faas:1.1.0
+To pull the Docker image:
+
+```sh
+docker pull shreyasnayak21/nodejs-faas:1.2.0
 ```
 
-Run using Docker:
+To run the Docker container:
 
-```
-docker run -p 9256:9256 shreyasnayak21/nodejs-faas:1.1.0
+```sh
+docker run -d -p 9256:9256 shreyasnayak21/nodejs-faas:1.2.0 --env JWT_KEY=QX2A0p84VmmLF3NYz3uHPx1hLuhT2U2K
 ```
 
-Pull using Containerd:
+### Using Containerd
 
-```
-nerdctl pull shreyasnayak21/nodejs-faas:1.1.0
+To pull the image with Containerd:
+
+```sh
+nerdctl pull shreyasnayak21/nodejs-faas:1.2.0
 ```
 
-Run using Containerd:
+To run the container with Containerd:
 
-```
-nerdctl run -p 9256:9256 shreyasnayak21/nodejs-faas:1.1.0
+```sh
+nerdctl run -d -p 9256:9256 shreyasnayak21/nodejs-faas:1.2.0 --env JWT_KEY=QX2A0p84VmmLF3NYz3uHPx1hLuhT2U2K
 ```
 
-Alternatively, you can use `pm2` to run the source code:
+### Using `pm2`
 
-```
+You can also run the source code using `pm2`:
+
+```sh
 npm install
 npm start
 ```
 
-You can run the Node using the following command:
+To start the NodeJS-FAAS using `pm2`:
 
-```
+```sh
 pm2 start index.mjs --name NodeJS-FAAS
 ```
 
-# How to use?
-Currently, we provide an interface over [HTTP API](openapi.json). You can create a lambda function or upload code formatted in an `mjs` file to the instance, and you can execute the function using the API. Additionally, there are plans to add NATS.io or Pub/Sub to trigger a function.
+## Usage
+
+Currently, NodeJS-FAAS provides an interface over an [HTTP API](openapi.json). You can create a lambda function or upload code in an `mjs` file to the instance and execute the function using the API. Future plans include adding NATS.io or Pub/Sub for function triggers.
 
-# Example Code
+## Example Code
 
-### Call Http API
+### Calling the HTTP API
 
 ```mjs
 const axios = require('axios');
 
 function main(event, context, callback) {
-    if(event=="get_nasa_image") {
+    if (event === "get_nasa_image") {
         const { key } = context;
         axios.get(`https://api.nasa.gov/planetary/apod?api_key=${key}`)
-        .then(response => {
-            if(callback) callback({
-                explanation: response.data.explanation
+            .then(response => {
+                if (callback) callback({
+                    explanation: response.data.explanation
+                });
+            })
+            .catch(error => {
+                if (callback) callback({
+                    error: error.message
+                });
             });
-        })
-        .catch(error => {
-            if(callback) callback({
-                error: error.message
-            });
-        });   
     }
 }
 
-main(G_EVENT_NAME,G_CONTEXT,G_CALLBACK);
+main(G_EVENT_NAME, G_CONTEXT, G_CALLBACK);
 ```
 
-# Generate token
-Genarte the .env file 
-`JWT_KEY=MY_SECRET_KEY`
+## Generating a Token
 
-`apt-get update`
+To generate a token, visit the [JWT Generator Website](https://jwt.io/). Use the JWT_KEY you provided for the container and input the following content in the body, adjusting the parameters as needed:
 
-`apt-get install jq jw`
+```json
+{
+    "expire_at": "1735713720",
+    "issued_at": "1721994397",
+    "issuer": "shreyas",
+    "namespace": "neo"
+}
+```