docs: rewrite readme in markdown

README.md

@@ -0,0 +1,56 @@
+# Rural Dictionary
+
+We're rural, not urban. A privacy respecting urban dictionary client, powered by Flask.
+
+## Instances
+
+| URL                                                                                                                                                                                 | Country | Ownername | Owner Website       |
+|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|-----------|---------------------|
+| <https://rd.vern.cc> + [Tor](http://rd.vernccvbvyi5qhfzyqengccj7lkove6bjot2xhh5kajhwvidqafczrad.onion) + [I2P](http://vern5cxiaufqvhv4hu5ypkvw3tiwvuinae4evdbqzrioql6s2sha.b32.i2p) | US      | ~vern     | <https://vern.cc>   |
+| <https://rd.bloat.cat>                                                                                                                                                              | RO      | bloatcat  | <https://bloat.cat> |
+
+## About
+
+Rural Dictionary scrapes urban dictionary for data and then displays it in html.
+
+## Support
+
+Join our [Matrix room](https://mto.vern.cc/#/#cobra-frontends:vern.cc) for support and other
+things related to Rural Dictionary
+
+## Supports
+
+- Define a word with multiple entries
+- Pagination
+- Random list of words
+- User pages
+- Urban Dictionary home with words of the day
+- Matches urban dictionary's endpoints for features listed above
+
+## Deploy with docker
+
+```sh
+rye build --wheel --clean
+docker buildx build . --tag rural-dict
+docker compose up -d
+```
+
+## Redirection
+
+To use Rural Dictionary, simply replace an Urban Dictionary URL with a Rural Dictionary URL from
+the instance list above.
+
+For example, change:
+
+`https://urbandictionary.com/define.php?term=kin`
+
+to:
+
+`https://rd.vern.cc/define.php?term=kin`
+
+**Note:** More endpoints are supported.
+
+## Contributors
+
+- [zortazert](https://codeberg.org/zortazert), created the initial Urban Dictionary frontend using
+  JavaScript and helped develop Rural Dictionary

README.org

@@ -1,49 +0,0 @@
-* Rural Dictionary
-
-We're rural, not urban. A privacy respecting urban dictionary client, powered by Flask.
-
-* Instances
-
-| URL                | Country | Ownername | Owner Website   |
-|--------------------+---------+-----------+-----------------|
-| https://rd.vern.cc + [[http://rd.vernccvbvyi5qhfzyqengccj7lkove6bjot2xhh5kajhwvidqafczrad.onion][Tor]] + [[http://vern5cxiaufqvhv4hu5ypkvw3tiwvuinae4evdbqzrioql6s2sha.b32.i2p][I2P]] | US      | ~vern     | https://vern.cc |
-| https://rd.bloat.cat | RO      | bloatcat | https://bloat.cat |
-
-* About
-Rural Dictionary scrapes urban dictionary for data and then displays it in html.
-
-* Support
-Join our [[https://mto.vern.cc/#/#cobra-frontends:vern.cc][Matrix room]] for support and other things related to Rural Dictionary
-
-* Supports
-- Define a word with multiple entries
-- Pagination
-- Random list of words
-- User pages
-- Urban Dictionary home with words of the day
-- Matches urban dictionary's endpoints for features listed above
-
-* Deploy with docker
-#+BEGIN_SRC
-rye build --wheel --clean
-docker buildx build . --tag rural-dict
-docker compose up -d
-#+END_SRC
-
-* Dependencies
-- bs4
-- requests
-- waitress
-- Relatively new version of python
-
-* Redirection
-Simply replace a urban dictionary url with a Rural Dictionary url from the instance list above.
-#+BEGIN_SRC
-https://urbandictionary.com/define.php?term=eevee
-
-https://rd.vern.cc/define.php?term=eevee
-#+END_SRC
-NOTE: More endpoints are supported
-
-* Contributors
-- https://codeberg.org/zortazert, created the initial Urban Dictionary frontend using JavaScript and helped develop Rural Dictionary

pyproject.toml

@@ -2,7 +2,7 @@
 name = "rural-dict"
 description = "Privacy-respecting, NoJS-supporting Urban Dictionary frontend."
 license = "AGPL-3.0-or-later"
-readme = { file = "README.org", content-type = "text/plain" }
+readme = "README.md"
 requires-python = ">=3.12"
 authors = [
     { name = "Zubarev Grigoriy", email = "thirtysix@thirtysix.pw" },