From f61f1e080ca76f09dc10cc1d9ed68880cea0f1b1 Mon Sep 17 00:00:00 2001
From: Andreas Zweili <andreas@2li.ch>
Date: Mon, 12 Oct 2020 14:23:23 +0200
Subject: [PATCH] add a README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c3795d0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+- url2markdown
+
+url2markdown lets you download an URL and save it as a Markdown file.
+Additionally you can provide a list of tags which will get added to the top of
+the file. The main idea behind the script is to download articles and feed them
+to an Obsidia.md vault already extended with internal Obsidian links.
+
+```
+url2markdown https://docs.python.org/3/howto/argparse.html --tags=Python,CLI
+```
+
+## Features
+
+- Provide an URL on the command line.
+- Provide a text file with a list of URLs and tags.
+
+## Installation
+
+Install url2markdown by running:
+
+```bash
+pip3 install url2markdown
+```
+
+## Contribute
+
+- Issue Tracker: github.com/Nebucatnetzer/url2markdown/issues
+- Source Code: github.com/Nebucatnetzer/url2markdown
+
+## Support
+
+You can open an issue at the Github repository however I don't garantee any
+support whatsever since this is a fully personal project more seen as an
+excersice.
+
+## License
+
+The project is licensed under the GPLv3 license.