🌌 readme-universe

Remix your boring README.md files into epic narratives — horror stories, fantasy epics, sci-fi sagas, poetic ballads, and more — right from VS Code.

---

✨ Features

• 📖 Rewrite any README.md file into:
  • 🧛 Horror
  • 🎭 Drama
  • 🧙 Fantasy
  • 🕵️ Mystery
  • 🤖 Sci-fi
  • 📝 Poetic
  • 🏴‍☠️ Anime
  • 🎮 League of Legends-themed
  • ⚔️ World of Warcraft-themed
  • 🌌 Star Wars-themed
  • 💍 Lord of the Rings-themed
• ⚙️ Choose between gpt-4 and gpt-3.5-turbo
• 💾 Save the remixed README as a new .md file
• 👀 Instantly preview the result
• 🪙 Keeps your original file safe — no overwrites

---

🧰 Requirements

• An OpenAI API key (get yours at platform.openai.com)
• Internet connection
• Be dramatic 😎

---

⚙️ Extension Settings

This extension contributes the following setting:

Setting	Description
readme-universe.apiKey	Your OpenAI API key (required to generate remixes)

To set it:

1. Open Command Palette → Preferences: Open Settings (UI)
2. Search for readme-universe
3. Paste your OpenAI key

---

🚀 How to Use

1. Open any README.md file
2. Run command: rewrite readme (via Command Palette)
3. Pick a style and model (horror & gpt-3.5-turbo)
4. View the remixed README
5. Save it as a new file when prompted (README.horror.md)
6. Brag about it in Slack

---

🪲 Known Issues

• Long READMEs may consume more tokens than expected — consider trimming before remixing
• OpenAI API usage may incur costs — choose model wisely

---

📦 Release Notes

[0.0.3] – 2025-05-18

Added

• 🖼️ Extension icon for Marketplace listing
• 📄 MIT license file

---

📚 Resources

• OpenAI API Pricing
• VS Code Extension Docs

---

❤️ Contribute

Have a fun style idea? Open a PR or file a GitHub issue. We love creative chaos

---

⚠️ Disclaimer

This extension uses your OpenAI API key. You are responsible for usage and associated costs. No data is stored or tracked.

---

🎉 Enjoy!

Now go forth, and make your README.md shine with style