From ff7e2c6f223cbd518aaa49290a99cc15d07d9b68 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Gabriele=20H=C3=B6fler?= <gabriele.hoefler@onb.ac.at>
Date: Fri, 5 Jul 2019 13:47:36 +0200
Subject: [PATCH] Add README

---
 README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..80159bc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,52 @@
+# Webarchive API
+
+* [Swagger](https://webarchiv.onb.ac.at/api.html)
+
+## [webarchiv.py](webarchiv.py)
+
+Module to establish a session for the [Webarchive Austria](https://webarchiv.onb.ac.at/) API and do things like
+checksum-extraction.
+
+## [Nationalrat2015](Nationalrat2015.ipynb)
+
+We analyse the changes of a pdf that shows the seating plan of the National Assembly of Austria by checksum.
+
+## [Innenminister2009-2019](Innenminister2009-2019.ipynb)
+
+We analyse the changes of the website of the Ministry of the Interior of Austria.
+
+## [sample1](sample1.ipynb)
+
+Get the Webarchive Austria metadata and analyse which crawls where dune during the European Song Contest 2015.
+
+## [sample2](sample2.ipynb)
+
+How to establish a session in the Webarchive.
+
+## [sample3](sample3.ipynb)
+
+Fulltext search and how to handle the response.
+
+## [sample4](sample4.ipynb)
+
+Get number of captures per site for a specific event.
+
+## [sample5](sample5.ipynb)
+
+Get domain names captured by the Webarchive Austria that contain the string "mozart".
+
+## [sample6](sample6.ipynb)
+
+Get the top hit by largest number of hits for a specific term searched.
+
+## [sample7](sample7.ipynb)
+
+Get previews of pages as blurred SVGs to see major changes in the site.
+
+## [sample8](sample8.ipynb)
+
+Add a page you want to be tracked in the Webarchive Austria.
+
+## [sample9](sample9.ipynb)
+
+Create a watchlist of a list of captures.
\ No newline at end of file
-- 
GitLab