Add files

1 files changed, 28 insertions, 0 deletions

diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..5c94d7f
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,28 @@
+This is a script to save an article from Newsboat RSS reader to an epub file.
+
+Setup
+------
+
+- copy the script into a file in ~/bin
+- make sure that ~/bin is included in $PATH ($ echo $PATH)
+- make the script executable by running 
+
+	$ chmod u+x script.sh
+
+- modify the path to the directory where you'd like epub files to be saved -- see comment in script
+- add these two lines to newsboat's config file, probably located at ~/.newsboat/config
+
+	# Save article .epub
+	macro S pipe-to "~/bin/save-article-to-epub.py" 
+
+Usage
+------
+
+- in Newsboat, when you want to save an article, press , then shift + S.
+
+License
+-------
+
+GPLv3
+
+Script originally written by Ludivico Gerardi.