aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGertjan van den Burg <gertjanvandenburg@gmail.com>2019-03-05 14:43:26 -0500
committerGertjan van den Burg <gertjanvandenburg@gmail.com>2019-03-05 14:43:26 -0500
commit09cdec43f857076462ad1f67ccf7b0deac538456 (patch)
tree1d24193c2fc23b3afe0663f255764b4a0794cd05 /README.md
parentUpdate script help (diff)
downloadpaper2remarkable-09cdec43f857076462ad1f67ccf7b0deac538456.tar.gz
paper2remarkable-09cdec43f857076462ad1f67ccf7b0deac538456.zip
Add support for PubMed Central papers
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/README.md b/README.md
index c8ff0fe..04712df 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,7 @@ This script makes it as easy to get a PDF on your reMarkable from any of the
following sources:
- an arXiv url (either ``arxiv.org/abs/...`` or ``arxiv.org/pdf/...``)
+- a PubMed Central url (either to the HTML or the PDF)
- a url to a PDF file
- a local file.
@@ -82,15 +83,16 @@ with the relevant options to the script.
The script also needs the following Python packages:
-- [BeautifulSoup4](https://pypi.org/project/beautifulsoup4/)
-- [requests](https://pypi.org/project/requests/)
-- [loguru](https://pypi.org/project/loguru/)
-- [PyPDF2](https://github.com/mstamy2/PyPDF2)
+- [BeautifulSoup4](https://pypi.org/project/beautifulsoup4/): parsing HTML
+- [requests](https://pypi.org/project/requests/): getting HTML
+- [loguru](https://pypi.org/project/loguru/): easy logging
+- [PyPDF2](https://github.com/mstamy2/PyPDF2): verifying urls point to PDF
+- [titlecase](https://pypi.org/project/titlecase/): fancy titles
You can use this line:
```bash
-pip install --user bs4 requests loguru PyPDF2
+pip install --user bs4 requests loguru PyPDF2 titlecase
```
# Notes