From afd4256a524439e1723e555edb1b2a630c9d6d35 Mon Sep 17 00:00:00 2001 From: Stone_Red <56473591+Stone-Red-Code@users.noreply.github.com> Date: Wed, 3 Apr 2024 17:44:25 +0200 Subject: [PATCH] Add "What is it?" section to readme --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 08f40b3..d1960ca 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,11 @@ # Markdowser > A web browser that renders markdown instead of HTML +## What is it? + +Markdowser is a web browser that renders Markdown instead of HTML.\ +It uses the [ReverseMarkdown](https://github.com/mysticmind/reversemarkdown-net) library to convert HTML websites to Markdown. This gets rid of all the clutter and is supposed to make the content more readable and consistent across different websites. + ## Setup 1. Download one of the [releases](https://github.com/Stone-Red-Code/Markdowser/releases). @@ -12,7 +17,6 @@ [![Twitter(X)](http://img.shields.io/badge/Twitter-black.svg?&logo=x&style=for-the-badge&logoColor=white)](https://twitter.com/search?q=%23Markdowser%20%40StoneRedCode&f=live) - ## Preview ![Screenshot 2024-04-03 173609](https://github.com/Stone-Red-Code/Markdowser/assets/56473591/e7a1b9f2-a416-448b-9e54-a91e5794ffb3)