From a7d78498243b97c8d4725883a07cc5f9ce06c335 Mon Sep 17 00:00:00 2001
From: SexbearLmao <81535451+SexbearLmao@users.noreply.github.com>
Date: Sun, 28 Mar 2021 16:58:07 -0500
Subject: [PATCH] Create README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9c5a935
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+#Marxist Ebook Scraper
+
+Use this script alongside Calibre to pull any number of articles from [Marxists.org](marxists.org) and convert them into a single ebook.
+
+##Requirements
+
+In addition to the python libraries listed in requirements.txt, this script requires [Calibre](https://calibre-ebook.com/) and its add-on [EpubMerge](https://www.mobileread.com/forums/showthread.php?t=169744). Right now the executables "ebook-merge" and "calibre-debug" must be in your path.
+
+Marxist Ebook
+
+##Usage
+
+python3 marxistbook.py [-h] [-o OUTPUT] [-t TITLE] [-a AUTHOR] url [url ...]
+
+positional arguments:
+
+  url                   urls to download
+
+optional arguments:
+
+  -h, --help
+  
+                        show this help message and exit
+  
+  -o OUTPUT, --output OUTPUT
+  
+                        name of output file
+                        
+  -t TITLE, --title TITLE
+  
+                        set the title manually
+                        
+  -a AUTHOR, --author AUTHOR
+  
+                        set the author manually (currently not working)