docs: update documentation in readme, contributing and development

Signed-off-by: Nicklas Silversved <nicklas.silversved@digg.se>

Author: brorlarsnicklas

CONTRIBUTING.md

@@ -73,8 +73,6 @@ Om du bestämmer dig för att lösa ett ärende, se till att kolla kommentarsfä
 
 Om någon har tagit på sig ett ärende men inte följer upp inom en vecka, går det bra att ta över – men lämna ändå en kommentar. Om det inte har varit någon aktivitet på ärendet på 7 till 14 dagar är det rimligt att anta att ingen jobbar på det.
 
-
-
 ## Återkoppling på ärenden och Pull Requests
 
 Projektunderhållare kommer att göra sitt bästa för att granska och svara på ärenden inom fem arbetsdagar.
@@ -134,10 +132,9 @@ För säkerhetssårbarheter, följ riktlinjerna i vår [Säkerhetsinformation](S
 - Håll dokumentationen lättläst.
 - Använd punktlistor för tydlighet.
 - Var koncis och länka till externa resurser vid behov.
-- Använd brittisk engelska (t.ex. "colour" istället för "color").
 - Följ [en-mening-per-rad](https://sembr.org/)-principen i Markdown eller AsciiDoc.
 
-Engelska är det primära språket, med översättningar på bästa möjliga sätt.
+Svenska är det primära språket.
 
 ## FOSS-standarder
 

README.md

@@ -24,57 +24,130 @@ Verktyget är specifikt utvecklat för att linta OpenAPI-definitioner enligt den
 
 - [REST API-profil - Lint Processor (RAP-LP)](#rest-api-profil---lint-processor-rap-lp)
   - [Innehållsförteckning](#innehållsförteckning)
-  - [Installation och krav](#installation-och-krav)
   - [Instruktioner för att komma igång snabbt](#instruktioner-för-att-komma-igång-snabbt)
   - [Versioner](#versioner)
   - [Användning](#användning)
   - [Begränsningar](#begränsningar)
   - [Support](#support)
+  - [FAQ](#faq)
   - [Bidra](#bidra)
   - [Utveckling](#utveckling)
   - [Licens](#licens)
   - [Underhållare](#underhållare)
   - [Krediter och referenser](#krediter-och-referenser)
 
-## Installation och krav
+## Instruktioner för att komma igång snabbt
 
-Det enklaste sättet att installera RAP-LP är genom att använda [npm](https://www.npmjs.com/):
+Förutsätter att det finns en `openapi.yaml` att validera i den aktuella katalogen och beroende på hur man önskar att nyttja verktyget måste det finns installerade versioner av `Node.js`,`npm`, `Podman` eller `Docker`.
+
+### NPM
+> Notera: Att GitHub Packages (npm) kräver authentisering.<br>
+> Projektets `.npmrc` bör vara konfigurerat mot rätt registry - `@diggsweden:registry=https://npm.pkg.github.com`
 
-1. Klona ned projektet från senaste release, gärna via latest release tag.
-2. Installera alla beroenden:
 
 ```bash
-npm install
+npm login --registry=https://npm.pkg.github.com
+# username: ditt GitHub-användarnamn
+# password: GitHub PAT med read:packages
 ```
 
-## Instruktioner för att komma igång snabbt
+> Om du saknar inloggning med GitHub Personal access token (PAT), se [FAQ](#hur-skapar-jag-ett-github-personal-access-token-pat).
+
+#### Installera globalt med npm:
+```bash
+npm i -g @diggsweden/rest-api-profil-lint-processor@latest
+raplp -f openapi.yaml
+```
+
+#### Installera lokalt som `npm run` script
+
+Installera och lägg som `devDependencies`:
+
+```
+npm i --save-dev @diggsweden/rest-api-profil-lint-processor@latest
+```
+
+Lägg till ett [`npm run` script](https://docs.npmjs.com/cli/run-script) i din `package.json` med rätt sökväg till filen du vill validera:
 
-Använd det här kommandot för att köra applikationen mot en YAML-fil:
+```json
+{
+  "scripts": {
+    "lint-processor": "raplp -f openapi.yaml"
+  }
+}
+```
+
+Nu kan du använda `npm run lint-processor`.
 
+### NPX
+Kör utan installation och package.json:
 ```bash
-npm start -- -f <PATH>/<YAML_FILE>
+npx @diggsweden/rest-api-profil-lint-processor@latest -f openapi.yaml
 ```
 
-**Exempel**
+### Podman
+Kör med podman:
+```bash
+podman run --rm -v $(pwd):/data ghcr.io/diggsweden/rest-api-profil-lint-processor:latest -f /data/openapi.yaml
+```
 
+### Docker
+Kör med docker:
 ```bash
-npm start -- -f apis/dok-api.yaml
+docker run --rm -v $(pwd):/data ghcr.io/diggsweden/rest-api-profil-lint-processor:latest -f /data/openapi.yaml
 ```
+> Notera: Sökvägar kan hanteras olika beroende på miljö:
+> - Podman (Linux/macOS/WSL): -v $(pwd):/app/example
+> - Docker (PowerShell): -v "${PWD}:/app/example"
+> - Docker (CMD): -v %cd%:/app/example
 
-## Versioner
-Senaste release tag ska alltid vara stabil och testad, vilket gör den till den föredragna versionen för att nyttja verktyget.
+### Bygga från källkod
+1. Klona ned projektet, gärna från senaste release tag.
+2. Installera alla beroenden:
 
+```bash
+npm install
+npm start -- -f openapi.yaml
+```
+> Notera: Att alla kommandon lokalt körs med `npm start --`.
+
+## Versioner
+Senaste release tag ska alltid vara stabil och testad, vilket gör den till den föredragna versionen för att nyttja verktyget.<br>
 Main och pre-releaser används med reservation för att all funktionalitet inte är garanterat stabil och testad.
 
 ## Användning
+Här beskrivs vilka användningsområden verktyget har med diverse flaggor som kan sättas för att nyttja verktygets funktionalitet.
+
+### Tillgängliga flaggor
+
+| Flagga | Beskrivning | Typ | Standard | Obligatorisk |
+|---|---|---|---|---|
+| `-f, --file` | Sökväg till OpenAPI-specifikation (YAML/JSON). | string | – | Ja |
+| `-c, --categories` | Regelkategorier separerade med kommatecken. Tillgängliga: `UfnRules, SakRules, VerRules, FnsRules, ArqRules, DokRules, AmeRules, ForRules, DotRules, FelRules`. | string | – | Nej |
+| `-l, --logError` | Sökväg till fil för felloggning från RAP-LP. Om inte angiven skrivs loggen till stdout. | string | stdout (om ej satt) | Nej |
+| `-a, --append` | Append—utökar loggen i befintlig felloggningsfil (om `--logError` används). | boolean | `false` | Nej |
+| `-d, --logDiagnostic` | Sökväg till fil för diagnostiseringsinformation från RAP-LP i JSON-format. | string | – | Nej |
+| `--dex` | Sökväg till fil för diagnostiseringsinformation från RAP-LP i Excel-format. | string | – | Nej |
 
-För att validera mot en specifik kategori av regler, lägg till `-c <CategoryName>`.
+
+> Notera: Att `raplp` i alla kommandon nedan ersätts med respektive miljös sätt att köra verktyget (npm, docker eller podman).
+
+### Validering med alla regler
+För att validera en openapi-definition med verktyget, lägg till `-f <YAML_FILE>`
+```bash
+raplp -f openapi.yaml
+```
 
 ### Validering med utvalda regler
-**Exempel**
+För att validera mot en specifik kategori av regler, lägg till `-c <CategoryName>`.<br>
+>Notera: Att du kan lägga till flera regler som en kommaseparerad lista.
 
 ```bash
-npm start -- -f apis/dok-api.yaml -c DokRules
+# Validera mot en specifik regel
+raplp -f openapi.yaml -c DokRules
+
+# Validera mot flera regler
+raplp -f openapi.yaml -c DokRules,AmeRules,SakRules
 ```
 
 #### Tillgängliga kategorier med regler
@@ -90,155 +163,58 @@ npm start -- -f apis/dok-api.yaml -c DokRules
 - UfnRules
 - VerRules
 
-För att spara meddelanden från felloggar, lägg till `-l <FILE>`.
-
-
-### Validering som skriver resultat till en valfri logfil
-
-**Exempel**
+### Validering som skriver felmeddelanden till en valfri loggfil
+För att skriva felmeddelanden till en valfri loggfil, lägg till `-l <FILE>`
 ```bash
-npm start -- -f apis/dok-api.yaml -l rap-lp.log
+raplp -f openapi.yaml -l raplp.log
 ```
+> Notera: Att varje körning skriver över den tidigare loggfilen.
 
-
-### Validering som skriver resultat till en valfri logfil samt loggar i terminalen
-För att lägga till loggning, lägg till `-a`
-
-**Exempel**
+För att lägga till loggning i samma fil, lägg till `-a`
 ```bash
-npm start -- -f apis/dok-api.yaml -l rap-lp.log -a
+raplp -f openapi.yaml -l raplp.log -a
 ```
 
 ### Validering som sparar loggdiagnostik i en fil
 För att spara loggdiagnostik i en fil, lägg till `-d <FILE>`
 
-**Exempel**
-
 ```bash
-npm start -- -f apis/dok-api.yaml -d logDiagnostic.log
+raplp -f openapi.yaml -d logDiagnostic.log
 ```
 
 ### Validering som sparar information om regelutfall i en Excel-fil
 
-För att spara information om regelutfall från diagnostiseringen till en avstämningsfil i Excel, lägg till --dex.
-
+För att spara information om regelutfall från diagnostiseringen till en avstämningsfil i Excel, lägg till `--dex`.<br>
 Om en specifik sökväg till avstämningsfilen ska anges, kan denna läggas till.<br>
 Om ingen sökväg anges, genererar verktyget automatiskt en ny avstämningsfil i den katalog där det körs.
 
-Avstämningsfilen i Excel har ett fast format, om en egen version av filen ska användas måste den utpekade resursen hämtas med en kompatibel version av REST API-profilen.
+[Avstämningsfilen](document/Avstaemning_REST_API_profil_v_1_2_0_0.xlsx) i Excel har ett fast format, om en egen version av filen ska användas måste den utpekade resursen hämtas med en kompatibel version av REST API-profilen.
 
 **Exempel utan sökväg till avstämningsfil i Excel**
 
 ```bash
-npm start -- -f apis/dok-api.yaml --dex
+raplp -f openapi.yaml --dex
 ```
 
 **Exempel med sökväg till avstämningsfil i Excel**
 
 ```bash
-npm start -- -f apis/dok-api.yaml --dex <PATH>
+raplp -f openapi.yaml --dex <PATH>
 ```
 
 ### Visa information version
 För att visa aktuell version av verktyget, lägg till `--version`
 
-**Exempel**
-
 ```bash
-npm start -- --version
+raplp --version
 ```
 
 ### Visa hjälp
 
 ```bash
-npm start -- --help
+raplp --help
 ```
 
-### Testa mot publicerat npm paket
-> OBS se till så att .npmrc verkligen är konfigurerat mot @diggsweden:registry=https://npm.pkg.github.com
-
-För att köra mot ett **publicerat** paket istället för lokala byggen, se [npm paket](https://github.com/diggsweden/rest-api-profil-lint-processor/pkgs/npm/rest-api-profil-lint-processor) för version och använd:
-
-
-```bash
-npm login --registry=https://npm.pkg.github.com
-# username: ditt GitHub-användarnamn
-# password: GitHub PAT med read:packages
-```
-
-> Om du saknar inloggning med GitHub PAT, se [Access till registry](#access-till-registry)
-
-Kör sedan: 
-```bash
-# npx @diggsweden/rest-api-profil-lint-processor@1.0.0 -f openapi-test.yaml -l rap-lp.log -d avstamning.xlsx
-npx @diggsweden/rest-api-profil-lint-processor@1.0.0 -f <PATH>/<YAML_FILE>
-``` 
-
----
-
-### Användning via podman/docker
-
-> För alla kommandon bör ***podman*** kunna ersättas med ***docker*** om så önskas.
-
-I en terminal kör:
-  ```bash
-  podman run --rm -it -v $(pwd):/<PATH> ghcr.io/diggsweden/rest-api-profil-lint-processor:<VERSION X.X.X> -f <PATH>/<YAML_FILE>
-  ```
-* Där \<PATH> motsvarar den path i containern som du vill att nuvarande katalog \$(pwd) mountas in i, containern får tillgång till dina filer i \$(pwd).
-* Där \<YAML_FILE> motsvarar den filen som du vill applicera valideringen på.
-* Där \<VERSION> mostsvarar den version av rest-api-profilen som du vill nyttja.
-
-Exempel
-  ```bash
-  podman run -it -v $(pwd):/app/example ghcr.io/diggsweden/rest-api-profil-lint-processor:1.0.0 -f example/dot-api.yaml -l example/rap-lp.log --dex example/avstamning.xlsx
-  ```
-
-Vid eventuella fel och du inte hittar rap-lp-error.log kan du behöva köra kommandot via containern enligt den alternativa instruktionen nedan.<br>
-Se till att containern har rättigheter att skriva till den katalog som du mountar, se [Skrivåtkomst till mount från container](#skrivåtkomst-till-mount-från-container).
-
-#### Alternativ att köra ifrån containern
-1. Starta en podman container:
-    - podman run --rm -it --entrypoint /bin/sh -v $(pwd):/\<PATH> ghcr.io/diggsweden/rest-api-profil-lint-processor:0.3.0
-2. Kör din validering ifrån containern:
-    - npm start -- -f \<PATH-TO-FILE>
-3. Lägg på önskade flaggor enligt tidigare exempel.
-
-Exempel:
-  ```bash
-  $ podman run --rm -it --entrypoint /bin/sh -v $(pwd):/apis ghcr.io/diggsweden/rest-api-profil-lint-processor:0.3.0
-
-  /app: $ npm start -- -f apis/dot-api.yaml -l rap-lp.log --dex example.xlsx
-  ```
-
-### Eventuella hinder med podman-kommando
-
-#### Access till registry
-
-Du kan behöva ett Personal Access Token (PAT) för din användare i github för att kunna hämta images från Github Container Registry (GHCR).
-1. Skapa PAT i github via settings -> developer settings -> tokens -> generate new token.
-    - viktigt att sätta read:packages
-    - spara ned ditt token
-2. Logga in med:
-    - kör i en terminal: podman login ghcr.io
-    - användarnamn: Ditt github-användarnamn.
-    - lösenord: ditt token från tidigare steg.
-3. Validera enligt tidigare exempel.  
-
-#### Skrivåtkomst till mount från container
-1. Kolla rättigheter
-    ```bash
-    ls -ld /path/to/mount
-    ```
-2. För att testa om det är ett åtkomstproblem kan du temporärt prova om det går efter du gett alla skrivrättigheter till den mountade katalogen:
-    ```bash
-    sudo chmod 777 /path/to/mount
-    ```
-3. Beroende på din miljö och vilka möjligheter du har, hantera åtkomstproblemet mer beständigt och återställ tidigare läs- och skrivrättigheter.
-4. Du kan även prova:  
-    ```bash
-    sudo podman run -it -v $(pwd):/app/example ghcr.io/diggsweden/rest-api-profil-lint-processor:1.0.0 -f example/dot-api.yaml -l example/rap-lp.log --dex example/avstamning.xlsx
-    ```
-
 ### Riktlinjer och förklaringar
 Vill du veta mer om de specifika reglerna som verktyget tillämpar, se avsnittet [GUIDELINES](GUIDELINES.md) för detaljer.
 
@@ -294,6 +270,29 @@ Kravet har bedömts ha allvarlighetsgraden Warning eftersom API:et bryter mot et
 
 Om du har frågor, funderingar, buggrapporter etc, vänligen kontakta [Digg - Agency for Digital Government](https://www.digg.se/)
 
+## FAQ
+### Hur skapar jag ett GitHub Personal Access Token (PAT)?
+1. Gå till GitHub → Settings → Developer settings → Personal access tokens → Fine-grained tokens → Generate new token.
+2. Sätt Name och Expiration (ha utgångsdatum!).
+3. Resource owner: välj din org/användare som äger paketen.
+4. Repository access: välj relevanta repo(n).
+5. Permissions:
+    - För GHCR (containers): Packages → Read (lägg även Write om du ska pusha).
+    - För npm.pkg.github.com (npm-paket): Packages → Read och se till att tokenet har åtkomst till det repo där paketet bor.
+6. Skapa token → kopiera värdet direkt (visas bara en gång).
+
+```bash
+npm login --registry=https://npm.pkg.github.com
+# username: ditt GitHub-användarnamn
+# password: GitHub PAT med read:packages
+```
+
+```bash
+podman login ghcr.io
+# username: ditt GitHub-användarnamn
+# password: GitHub PAT med read:packages
+```
+
 ## Bidra
 
 Om du vill bidra till projektet, vänligen följ instruktionerna i avsnittet [Contributing](CONTRIBUTING.md).