From 7ec5778ed92fd6f0f6bafc0e1ff0469c5af68d17 Mon Sep 17 00:00:00 2001
From: "Glenn Y. Rolland" <glenux@glenux.net>
Date: Sun, 7 Feb 2021 14:40:32 +0100
Subject: [PATCH] Add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f005944
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+
+# FOSDEM Recorder
+
+## Prerequisites
+
+* Make sure you have Ruby installed
+* Make sure you have the 'bundler' Gem installed
+
+## Installation
+
+Install project dependencies
+
+    $ bundle install
+
+## Usage
+
+Get information about given URL
+
+    $ bundle exec fosdem-recorder info URL
+
+Schedule video download for given URL
+
+    $ bundle exec fosdem-recorder download URL
+
+Real example
+
+```shell-session
+$ bundle exec fosdem-recorder info https://fosdem.org/2021/schedule/event/sca_weclome/
+* title = FOSDEM 2021 - Software Composition Analysis Devroom Welcome
+* start = 14:00
+* stop = 14:05
+* diff = 00:05:00
+* url = https://stream.fosdem.org/dcomposition.m3u8
+
+$ bundle exec fosdem-recorder info https://fosdem.org/2021/schedule/event/sca_weclome/
+[... schedules the download ... ]
+[... a MP4 file will be created once the video is downloaded ...]
+```
+