From 827fd881108970f3308a13f664009cab40fdc3f8 Mon Sep 17 00:00:00 2001
From: WebStreamr <210764791+webstreamr@users.noreply.github.com>
Date: Sat, 17 May 2025 20:43:27 +0200
Subject: [PATCH] docs: add basic README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9cac02b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# WebStreamr
+
+[Stremio](https://www.stremio.com/) add-on which provides HTTP URLs from streaming websites.
+
+## Public instance
+
+A public instance is available at https://webstreamr.hayd.uk. Hosting infrastructure for this instance is donated by [ElfHosted](https://elfhosted.com), and independently maintained by [Hayduk](https://hayd.uk).
+
+## Hosting
+
+Don't want to use the public instance, or concerned about reliability during periods of high use? It's open-source, you can host it yourself!
+
+### ElfHosted (easy mode)
+
+Self-hosting to stressful? ElfHosted offer [ready-to-go, turn-key WebStreamr instances](https://store.elfhosted.com/product/webstreamr/) with $1, 7-day trials. Additionally, 33% of your subscription directly supports your developer! ❤️
+
+(*ElfHosted also offer advanced private hosting of the [top Stremio Addons](https://store.elfhosted.com/product-category/stremio-addons/elf/webstreamr/), as well as [turn-key bundles providing streaming from RealDebrid with Plex, Emby, or Jellyfin](https://store.elfhosted.com/product-category/streaming-bundles/elf/webstreamr/)*)
+
+### Self-Hosting
+
+You can build an image using the [Dockerfile](./Dockerfile) and run it.
+
+Alternatively, you can also start WebStreamr directly via
+
+```shell
+npm install
+npm run build
+npm start
+```