chore: added a better README

Author: math-queiroz

README.md

@@ -1,27 +1,118 @@
 # Rusty Typewriter
 
-Rusty-Typewriter is a theme for Hugo sites made by [math-queiroz](https://github.com/math-queiroz). It's intended to be simple and used for blogs, being mostly inspired by the current [Zen Browser's website](https://zen-browser.app/) in style and other Hugo themes in functionality. It was initially intended for personal use, but made public for whomever find it worth using.
+[![Hugo Version](https://img.shields.io/badge/hugo-0.121.0+-blue.svg)](https://github.com/gohugoio/hugo/releases)
+[![License](https://img.shields.io/github/license/math-queiroz/rusty-typewriter)](LICENSE)
+[![Release](https://img.shields.io/github/v/release/math-queiroz/rusty-typewriter)](https://github.com/math-queiroz/rusty-typewriter/releases)
+[![Stars](https://img.shields.io/github/stars/math-queiroz/rusty-typewriter)](https://github.com/math-queiroz/rusty-typewriter/stargazers)
+[![Issues](https://img.shields.io/github/issues/math-queiroz/rusty-typewriter)](https://github.com/math-queiroz/rusty-typewriter/issues)
+
+A minimalist and elegant Hugo theme inspired by vintage typewriters, perfect for writers, bloggers, and content creators who appreciate a clean, distraction-free writing experience.
 
 ![preview](https://raw.githubusercontent.com/math-queiroz/rusty-typewriter/main/images/screenshot.png)
 
 ## Features
 
-- Dark/Light Mode
-- Search
-- Side Pane
-- Customization Flgas
-- CSS Styling
-- I18n support
-- Responsive layout
+- 🎨 Clean, minimalist design with a vintage typewriter aesthetic
+- 📱 Fully responsive layout
+- 🔍 Built-in search functionality
+- 📚 Table of contents support
+- 🏷️ Custom taxonomies by default
+- 📝 Rich markdown support with syntax highlighting
+- 📋 Customizable sidebar
+- 🔄 Related posts suggestions
+- 📎 File attachments support
+
+## Quick Start
+
+1. Create a new Hugo site:
+```bash
+hugo new site my-blog
+cd my-blog
+```
+
+2. Add the theme as a git submodule:
+```bash
+git init
+git submodule add https://github.com/yourusername/rusty-typewriter.git themes/rusty-typewriter
+```
+
+3. Start the development server:
+```bash
+hugo server
+```
+
+## Configuration
+
+The theme offers extensive configuration options through your site's `config.toml` file. Here are the main settings:
+
+```toml
+[params.rtwt]
+  sidePane = true
+  countPageItems = 7
+
+[params.rtwt.home]
+  showBio = true
+  showAuthorImg = true
+  sidePaneTags = true
+  showFeatured = true
+  showRecent = true
+  hideRecentWhenFeatured = true
+  countRecent = 5
+
+[params.rtwt.side.home]
+  sidePaneSticky = false
+  taxonomies = ['tags']
+  countTaxonomy = 5
 
-## Using the theme
+[params.rtwt.side.single]
+  sidePaneSticky = true
+  showDetails = true
+  showTableOfContents = true
+  showAttachments = true
+  showRelated = true
+  countRelated = 5
+```
 
-Info on how to use the theme can be found [here](https://math-queiroz.github.io/rusty-typewriter/posts/getting-started)!
+### Front Matter Options
 
-## Documentation
+```toml
++++
+title = "Your Post Title"
+date = "2024-03-28"
+tags = ["tag1", "tag2"]
+topics = ["topic1"]
+my_taxonomies = ["value"]
+featured = true
++++
+```
 
-The documentation for theme features can be found in the [example page](https://math-queiroz.github.io/rusty-typewriter).
+## Customization
+
+### CSS Customization
+
+You can customize the theme's appearance by creating a custom CSS file:
+
+1. Create `assets/css/custom.css` in your site
+2. Add your custom styles
+3. The theme will automatically include your custom CSS
+4. You may take a look at `_root.css` for existing theme values and variables
+
+> If a css file starts with an undescore (_), it will be bundled with the theme default ones, which may affect caching behavior!
+
+### Layout Customization
+
+The theme's templates can be overridden by creating corresponding files in your site's `layouts` directory.
 
 ## Contributing
 
-Contributing guidelines soon, for now consider leaving feedback/ideas in discussions, or reporting bugs in issues ;)
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This theme is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.
+
+## Credits
+
+- Inspired by vintage typewriters and minimalist design
+- Built with [Hugo](https://gohugo.io/)
+- Icons from [Feather Icons](https://feathericons.com/)