move api to a subdir to conglomerate repos

Author: PipeItToDevNull

.github/workflows/Build.yaml renamed to .github/workflows/bsod-api-container.yaml

@@ -29,5 +29,5 @@ jobs:
 
     - name: Build and push
       run: |
-        docker build -t ${{ env.REGISTRY }}/${{ env.REPO }}/${{ env.IMAGE}}:latest .
+        docker build -t ${{ env.REGISTRY }}/${{ env.REPO }}/${{ env.IMAGE}}:latest /api/Dockerfile
         docker push ${{ env.REGISTRY }}/${{ env.REPO }}/${{ env.IMAGE}}:latest

Dockerfile renamed to api/Dockerfile

@@ -0,0 +1,14 @@
+# BSOD-API
+
+A basic API to injest `.dmp` files and return analyzed text.
+
+## Usage
+With a file
+```bash
+curl.exe -X PUT http://localhost:3000/analyze-dmp -F "dmpFile=@path/to/test.dmp"
+```
+
+With a URL
+```bash
+curl -X PUT http://localhost:3000/analyze-dmp -F "url=http://example.com/file.dmp"
+```

api/USAGE.md

@@ -138,14 +138,14 @@ app.put('/analyze-dmp', upload.single('dmpFile'), async (req, res) => {
 
 // GET endpoint to render README.md as HTML
 app.get('/', (req, res) => {
-    const readmePath = path.join(__dirname, 'README.md');
+    const readmePath = path.join(__dirname, 'USAGE.md');
     fs.readFile(readmePath, 'utf8', (err, data) => {
         if (err) {
             logger.error(`Error reading README file: ${err.message}`);
             res.status(500).send(`Error reading README file: ${err.message}`);
             return;
         }
-        const htmlContent = marked(data);
+        const htmlContent = marked(data, { mangle: false, headerIds: false });
         res.send(htmlContent);
     });
 });