From 3a3b666377c097c9182df47cde9b644437f1c8fd Mon Sep 17 00:00:00 2001
From: Mathilde Hertaas <maimh@stud.ntnu.no>
Date: Thu, 6 Mar 2025 11:54:56 +0100
Subject: [PATCH] further improvment of Readme file
---
README.md | 60 +++++++++++++++++++++++++++++++++++--------------------
1 file changed, 38 insertions(+), 22 deletions(-)
diff --git a/README.md b/README.md
index 2a66c7b..e730012 100644
--- a/README.md
+++ b/README.md
@@ -1,33 +1,49 @@
-### Assignment 1
+# Assignment 1
+
+## Kjøre koden
+Koden kjøres ved å skrive følgende kommando i terminalen:
+
+```sh
+go run main.go
+```
+
+Når serveren starter, kan du åpne nettleseren og navigere til:
+ * http://localhost:8080/ - Dette er hjemmesiden til API-et.
+ - Når serveren startes er det hit du eventuelt blir sendt automatisk
+ * Alternativt kan du bruke en av endepunktene beskrevet nedenfor for å navigere applikasjonen
-## Kjøre koden
-koden kjøres ved å skrive go run main.go i temrinalen
- - Da blir du eventuelt automatisk sendt til
- http://localhost:8080/
- Dette er Hjemmeside
- - Eventuelt kan du bruke fremgangsmåtene under Endepunkter for å navigere applikajsonen
## Hjemmeside (/)
-Når du åpner API-et uten spesifikke forespørsler (http://localhost:8080/),
-vil du bli sendt til en JSON-side med informasjon om hvordan du bruker API-et.
+Når du åpner API-et uten spesifikke forespørsler (http://localhost:8080/), vil du få en JSON-respons med informasjon om hvordan du bruker API-et.
-Her får du informasjon om de tre endepunktene som er tilgjengelige:
- 1. info
- 2. populasjon
- 3. status
-Du får også se hvordan riktig format av url forespørsel til en av disse endepunktene
-vil se ut og eksempler på riktig bruk.
+Her får du informasjon om de tre tilgjengelige endepunktene:
+ 1. info - Henter generell informajson om et land.
+ 2. populasjon - Henter populasjonsdata for et land.
+ 3. status - Viser status for API-et.
+I tillegg vises eksempler på hvordan du kan sende forespørsler til de ulike endepunktene.
## Endepunkter
-#info
- 1. Hente informasjon om et land basert på en 2-letter country codes (ISO 3166-2).
- * Endpoint: /countryinfo/v1/info/{country_code}{?limit=10}
+### info
+ 1. Hente informasjon om et land basert på en 2-bokstavs landkode (ISO 3166-2).
+ ```sh
+ http://localhost:8080/countryinfo/v1/info/{country_code}{?limit=10}
+ ```
* Metode: GET
* Eksempel: http://localhost:8080/countryinfo/v1/info/NO?limit=4
-#populasjon
- 2. Hente populasjonsdata
- GET http://localhost:8080/population/NO
- GET http://localhost:8080/population/NO?limit=2010-2015
+#### populasjon
+ 2. Hente populasjonsdata om et land basert på en 2-bokstavs landkode (ISO 3166-2).
+ ```sh
+ http://localhost:8080/countryinfo/v1/population/{country_code}{?startyear-endYear}
+ ```
+ *Metode: GET
+ * Eksempel: http://localhost:8080/population/NO?limit=2010-2015
+
+### status
+ 3. Viser status for de eksterne API-ene, versjon og applikasjonens oppetid.
+ ```sh
+ http://localhost:8080/countryinfo/v1/status
+ ```
+
--
GitLab