🔨 chore: updated README

Author: casperiv0

README.md

@@ -4,12 +4,24 @@ Automatically updates your GitHub bio with your WakaTime stats every 15 minutes
 
 ## Installation
 
+### Usage
+
 1. Clone the repo: `git clone https://github.com/Dev-CasperTheGhost/update-github-bio`
 2. Install the dependencies: `npm install`
 3. Copy and rename `.env.example` to `.env`
 4. Update your credentials in `.env`
    - GitHub token: <https://github.com/settings/tokens> make sure to select the `user` scope
    - WakaTime api key: <https://wakatime.com/settings/api-key>
+5. Start it! `npm run start`
+6. It should be running if nothing was returned!
+
+### Running for 24/7
+
+You can use [`pm2`](https://www.npmjs.com/package/pm2) to start this process in the background
+
+1. Make sure that you have followed the steps above
+2. Install pm2 globally: `npm install -g pm2`
+3. Start it! `pm2 start npm --name github-bio --run start`
 
 ## License
 

package-lock.json

@@ -4,7 +4,8 @@
   "description": "Automatically updates your GitHub bio with your WakaTime stats every 15 minutes",
   "main": "src/index.ts",
   "scripts": {
-    "dev": "nodemon src/index.ts"
+    "dev": "nodemon src/index.ts",
+    "start": "ts-node src/index.ts"
   },
   "keywords": [],
   "author": "Dev-CasperTheGhost",
@@ -14,9 +15,9 @@
     "dotenv": "^8.2.0"
   },
   "devDependencies": {
-    "@types/node": "^14.14.22",
+    "@types/node": "^14.14.31",
     "nodemon": "^2.0.7",
     "ts-node": "^9.1.1",
-    "typescript": "^4.1.3"
+    "typescript": "^4.2.2"
   }
 }

package.json

@@ -17,7 +17,7 @@ async function getWakatimeTotalTime(): Promise<string | undefined> {
       method: "GET",
       url: ENDPOINTS.WAKATIME,
       params: {
-        api_key: process.env.WAKATIME_API_KEY,
+        api_key: process.env["WAKATIME_API_KEY"],
         scope: "read_logged_time",
         start: new Date(Date.now()),
         end: new Date(Date.now()),
@@ -41,7 +41,7 @@ async function updateBio(message: string) {
       url: ENDPOINTS.GITHUB,
       headers: {
         Accept: "application/vnd.github.v3+json",
-        Authorization: `token ${process.env?.GH_TOKEN}`,
+        Authorization: `token ${process.env["GH_TOKEN"]}`,
       },
 
       data: {