Nebucatnetzer
/
url2markdown
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

update the readme

This commit is contained in:
Andreas Zweili 2020-10-13 21:30:46 +02:00
parent 9f69b4d2dc
commit 251cab1ebb
1 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -1,4 +1,4 @@
- url2markdown # url2markdown
url2markdown lets you download an URL and save it as a Markdown file. 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 Additionally you can provide a list of tags which will get added to the top of
@ -22,11 +22,29 @@ Install url2markdown by running:
pip3 install url2markdown pip3 install url2markdown
``` ```
or by running:
```bash
make
```
Which will produce an executable called `url2markdown` under `dist`.
## Contribute ## Contribute
- Issue Tracker: github.com/Nebucatnetzer/url2markdown/issues - Issue Tracker: github.com/Nebucatnetzer/url2markdown/issues
- Source Code: github.com/Nebucatnetzer/url2markdown - Source Code: github.com/Nebucatnetzer/url2markdown
### Development
If you want to start developing run the following two commands to make sure
your'e ready to go:
```bash
make init
make test
```
## Support ## Support
You can open an issue at the Github repository however I don't garantee any You can open an issue at the Github repository however I don't garantee any