From d1e434b610e9199c59aad5ebcb6959ead2dea3f6 Mon Sep 17 00:00:00 2001
From: Moss <moss@mossx.net>
Date: Tue, 13 Sep 2022 21:07:03 -0400
Subject: [PATCH] readme: Added basic use info

---
 readme.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 57 insertions(+)

diff --git a/readme.md b/readme.md
index e69de29..ce9cfe2 100644
--- a/readme.md
+++ b/readme.md
@@ -0,0 +1,57 @@
+# dropout-dl
+a tool to download [dropout.tv](dropout.tv) episodes.
+
+
+## how to build
+```
+cmake -S <source-dir> -B <build-dir>
+cd <build-dir>
+make
+```
+
+## setup
+the sqlite and curl libraries are required \
+additionally [cookies](#cookies) are needed
+
+### dependency installation
+#### void linux
+```
+sudo xbps-install -S libcurl
+```
+
+#### debian
+```
+sudo apt install libcurl
+```
+
+## cookies
+### firefox
+#### option 1 (requires sqlite-devel)
+create a file named `firefox_profile` in the build directory and paste in your [firefox profile folder path](https://support.mozilla.org/en-US/kb/profiles-where-firefox-stores-user-data)
+#### option 2 (requires sqlite)
+close firefox and go to your [firefox profile folder](https://support.mozilla.org/en-US/kb/profiles-where-firefox-stores-user-data)
+```
+sqlite3 cookies.sqlite "SELECT value FROM moz_cookies WHERE host LIKE '%dropout.tv%' AND name='__cf_bm';" > <build-dir>/auth_cookie
+sqlite3 cookies.sqlite "SELECT value FROM moz_cookies WHERE host LIKE '%dropout.tv%' AND name='_session';" > <build-dir>/session_cookie
+```
+this needs to be redone every time the cookies expire (~1-2 hours)
+#### option 3
+open firefox and go to any dropout.tv episode \
+open the dev tools and go to network then refresh \
+search for `?api` and select the top request \
+copy the `__cf_bm` cookie from the cookies section \
+create a file called `auth_cookie` and paste the cookie in the file \
+go back to firefox and copy the `_session` cookie into a file named `session_cookie` \
+this needs to be redone everytime the cookie expires (~1-2 hours)
+### chrome
+go to settings > privacy and security > cookies > see all cookies > vhx.tv > __cf_bm \
+copy the `content` and paste it into the `cookie` file \
+this needs to be redone every time the cookies expire (~1-2 hours)
+
+## how to use
+run the command
+```
+./dropout-dl <episode-url>
+```
+dropout-dl will download the episode into a folder with the name of the series in the format
+`S<season-num>E<episode-num><name>.mp4`
\ No newline at end of file