From dceaa0b73c4e0c007844fc1f68fef103d02c99d4 Mon Sep 17 00:00:00 2001
From: Daniel von Obernitz <daniel.vonobernitz@uni-greifswald.de>
Date: Thu, 9 Jan 2025 13:10:19 +0100
Subject: [PATCH] Add README

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

diff --git a/README.md b/README.md
index 32bcd47..d2c2c33 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,23 @@
 # easyroam
 
+Please follow the steps below to setup eduroam wifi on devices using Ubuntu/Linux. We presume that you are using the NetworkManager.
+
+You will need a connection to the internet (e.g. ethernet cable or mobile) to setup easyroam.
+
+## Create and download configuration profile
+
+First log in at https://easyroam.de.
+
+After logging in, select **Manual options**. Select the option **PKCS12** and enter a name for the profile.
+
+You will then receive a PKCS12 file for download.
+
+## Install the profile
+
+Download the easyroam-Installer skript from this repository. Then create your eduroam configuration using the previously downloaded PKCS12 file (if you are using the NetworkManager):
+
+```bash
+bash configure-eduroam-with-easyroam "YOUR-PKCS12-File"
+```
+
+Now the eduroam wifi should connect automatically.