From 8d85a38035dc110693b054e93fd4f37c1cbd6ad4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=96m=C3=BCr=20=C3=96zkir?= <oemuer.oezkir@gmail.com>
Date: Tue, 28 Jul 2020 15:42:54 +0200
Subject: [PATCH] adds more up to date documentation

---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/README.md b/README.md
index cca33ad4..a61d4726 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,28 @@
 # Hamburg.jl
 
 A little package that makes various information about Hamburg, Germany available in an easily accessible fashion.
+
+## Usage
+
+```julia
+using Hamburg
+datasets(topic, dataset)
+```
+
+## Topics
+
+### covid-19
+
+Source: [hamburg.de](https://www.hamburg.de/corona-zahlen)
+
+#### datasets
+
+**infected**: Number of people infected by covid-19, recorded since July 27, 2020
+
+`datasets("covid-19", "infected")`
+
+**boroughs**: The number infected, by borough.
+
+These are aggregated numbers, representing the cases for the last 14 days. This is so that the privacy of individuals can be guaranteed.
+
+`datasets("covid-19", "boroughs")`