Add README.md

Signed-off-by: Adrian Reber <[email protected]>

.github/workflows/ci.yml

@@ -7,6 +7,17 @@ on:
     branches: [ main ]
 
 jobs:
+  lint_markdown:
+    name: Run markdown linter
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Lint markdown
+      uses: DavidAnson/markdownlint-cli2-action@v15
+      with:
+        globs: |
+          README.md
+
   build:
     name: Run cargo build, cargo clippy and tests
     runs-on: ubuntu-latest

README.md

@@ -0,0 +1,9 @@
+# ohpc-log-analyzer
+
+This repository contains the code for `ohpc-log-analyzer`. This is a tool,
+written in Rust, which is specifically written to analyze the Apache HTTP
+Server log files generated on [OpenHPC](https://openhpc.community/)'s
+[repository server](https://repos.openhpc.community/).
+
+The output which is generated by `ohpc-log-analyzer` can be seen at
+<https://repos.openhpc.community/stats/>.