docs: rewrite readme

- fix wording
- add deployment without Docker instructions
- add license section
- add wonderful emojis

README.md

@@ -1,33 +1,38 @@
-# Rural Dictionary
+# 📖 Rural Dictionary
 
-We're rural, not urban. A privacy respecting urban dictionary client, powered by Flask.
+> We're rural, not urban.
 
-## Instances
+Privacy-respecting, NoJS-supporting Urban Dictionary frontend.
 
-| 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> |
+## 🌐 Instances
 
-## About
+| URL                                                                                                                                                                                 | Country | Owner name | 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> |
 
-Rural Dictionary scrapes urban dictionary for data and then displays it in html.
+## ✨ Features
 
-## Support
+- Word definitions
+- Author pages
+- Homepage with words of the day
+- Random word definitions
+- Pagination
+- Matches Urban Dictionary's endpoints for features listed above
 
-Join our [Matrix room](https://mto.vern.cc/#/#cobra-frontends:vern.cc) for support and other
-things related to Rural Dictionary
+## 🚀 Deployment
 
-## Supports
+First, install Rye by following
+the [installation guide](https://rye.astral.sh/guide/installation/).
 
-- 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
+Then, clone repository:
+
+```sh
+git clone https://git.vern.cc/cobra/rural-dict
+cd rural-dict
+```
 
-## Deploy with docker
+### 🐳 With Docker
 
 ```sh
 rye build --wheel --clean
@@ -35,10 +40,34 @@ docker buildx build . --tag rural-dict
 docker compose up -d
 ```
 
-## Redirection
+### 💻 Without containerization
+
+```sh
+rye sync --no-dev
+rye run uvicorn src.rural_dict.__main__:app --port 8080
+```
+
+## 🔧 Development
+
+Use `rye sync` to install dependencies and required Python version.
+
+Use `rye run dev` to start development server which will reload on every change to source code.
+
+Use `rye check --fix` and `rye fmt` to lint and format code. Assumed to be run before each commit
+to guarantee code quality.
+
+Use `rye run basedpyright` to ensure typing is correct.
+
+## 🤝 Support
+
+Join our [Matrix room](https://mto.vern.cc/#/#cobra-frontends:vern.cc) for support and other
+things related to Rural Dictionary.
+
+## 🔗 Redirection
 
 To use Rural Dictionary, simply replace an Urban Dictionary URL with a Rural Dictionary URL from
-the instance list above.
+the instance list above. Auto-redirect browser extension
+like [Redirector](https://github.com/einaregilsson/Redirector) can be used to achieve this.
 
 For example, change:
 
@@ -50,7 +79,12 @@ to:
 
 **Note:** More endpoints are supported.
 
-## Contributors
+## 👥 Contributors
 
+- [thirtysix](https://thirtysix.pw), rewrote project in more modern Python stack
 - [zortazert](https://codeberg.org/zortazert), created the initial Urban Dictionary frontend using
   JavaScript and helped develop Rural Dictionary
+
+## 📜 License
+
+This project is licensed under the AGPLv3+ license - see the [license file](LICENSE) for details.