aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMichael Tews <michael@tews.dev>2025-11-12 10:12:31 +0100
committerMichael Tews <michael@tews.dev>2025-11-12 10:12:31 +0100
commitc6866e62087d38b83cd6038e9be94f4792b424ae (patch)
treee7d518b950a265d89fe8fd2f2393b96edc22e454 /README.md
parent2cd18224bbb8e65e6cb927615e4d9503e3802177 (diff)
feat: first working version
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/README.md b/README.md
index 0c661ee..b8a785d 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,7 @@
-# StudIP backend for rclone
+# Stud.IP Backend for rclone
+
+This project provides an **rclone backend** for accessing files from **Stud.IP** instances.
+
+Although it should work with all Stud.IP instances, it has currently only been tested with the [University of Bremen](https://elearning.uni-bremen.de) installation.
+
+**Note:** This is a **proof of concept** and currently offers **limited functionality (read-only access)** and **may contain bugs**.