feat(docs): remove hello world

krystxf · Jun 18, 2024 · 586f298 · 586f298
1 parent 19eca0a
commit 586f298
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 3 deletions.
diff --git a/backend-nest/src/app.service.ts b/backend-nest/src/app.service.ts
@@ -3,6 +3,14 @@ import { Injectable } from "@nestjs/common";
 @Injectable()
 export class AppService {
     getHello(): string {
-        return "Hello World!";
+        return `
+            <h1>
+                Hello, fellow developer👋
+            </h1>
+            <p>
+                Thank you for checking out my project.
+                You can find the API documentation <a href="https://metro-now.vercel.app/docs/rest-api">here</a>.
+            </p>
+        `;
     }
 }
diff --git a/docs/src/pages/docs/rest-api.mdx b/docs/src/pages/docs/rest-api.mdx
@@ -46,9 +46,9 @@ GET https://api.metronow.dev/metro?station=["Anděl","Dejvická"]
 {
     [platform id]: [
         {
-            "delay": "number", // seconds
+            "delay": "int", // in seconds (can be negative)
             "departure": "string", // ISO 8601
-            "heading": "string", // station
+            "heading": "string", // last stop
             "line": "A" | "B" | "C"
         }
     ]