From 9687b42c93f1acf8c3c9f05aeae10d54fb08435a Mon Sep 17 00:00:00 2001
From: Stefano Pigozzi <ste.pigozzi@gmail.com>
Date: Mon, 26 Oct 2020 18:14:14 +0100
Subject: [PATCH] =?UTF-8?q?=F0=9F=97=92=20Create=20basic=20readme?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md      | 42 ++++++++++++++++++++++++++++++++++++++++--
 pyproject.toml |  4 ++--
 2 files changed, 42 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 2883c0b..91d1f76 100644
--- a/README.md
+++ b/README.md
@@ -2,8 +2,46 @@
 
 A tool for downloading BigBlueButton meetings
 
+## Requirements
+
+- [`Python 3.8+`](https://www.python.org/)
+- [`ffmpeg`](https://ffmpeg.org/download.html)
+- [`pipx`](https://pipxproject.github.io/pipx/installation/)
+
 ## Installing
 
+Run the following command:
+```
+pipx install bbbdl
+```
+
+## Usage
+
+### Download a single BigBlueButton meeting
+
+```
+bbbdl download -i {MEETING_URL} -o {OUTPUT_FILE_NAME}
+```
+
+### Download all meetings from a list
+
+```
+bbbdl sync -j {LIST_FILE}
+```
+
+### Download all meetings from a remote list
+
+```
+bbbdl sync -r {LIST_FILE_URL}
+```
+
+## Meeting list format
+
+A JSON file containing an object with filename/url pairs:
+
+```json
+{
+  "a.mp4": "https://example.org/playback/presentation/2.0/playback.html?meetingId=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-1111111111111",
+  "b.mp4": "https://example.org/playback/presentation/2.0/playback.html?meetingId=bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb-2222222222222"
+}
 ```
-pip install bbbdl
-```
\ No newline at end of file
diff --git a/pyproject.toml b/pyproject.toml
index d30f925..40a2784 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "bbbdl"
-version = "1.0.0"
+version = "1.0.2"
 description = "A downloader for BigBlueButton meetings"
 authors = [
     "Stefano Pigozzi <ste.pigozzi@gmail.com>",
@@ -17,7 +17,7 @@ ffmpeg-python = "^0.2.0"
 lxml = "^4.6.1"
 
 [tool.poetry.scripts]
-bbbdl = 'bbbdl.__main__:download'
+bbbdl = 'bbbdl.__main__:main'
 
 [build-system]
 requires = ["poetry>=0.12"]