diff --git a/README.md b/README.md index 3f47d4b..8900a04 100644 --- a/README.md +++ b/README.md @@ -1,57 +1,56 @@ -# **Polydev** ๐ŸŒ +# Polydev -**Polydev** is a powerful multi-lingual plugin for Neovim that streamlines project management, file creation, building, and running codeโ€”all within your favorite terminal editor. Whether you're coding in Java, Python, Lua, Rust, or more, Polydev brings seamless integration and enhanced productivity right to your fingertips. +**Polydev** is a multi-language plugin for Neovim that streamlines project management, file creation, building, and running codeโ€”all within your terminal. Whether you're coding in Java, Python, Lua, Rust, or more, Polydev provides seamless integration to boost your productivity inside Neovim. -![720p-Polydev](https://github.com/user-attachments/assets/c8e84056-5080-4ec3-ba15-30be61faaf68) +![Polydev Preview](https://github.com/user-attachments/assets/c8e84056-5080-4ec3-ba15-30be61faaf68) --- -## ๐Ÿš€ **Quick Features** +## Features -Polydev helps you work smarter, not harder. With this plugin, you can: +* Create and manage projects directly from Neovim +* Generate new files quickly +* Build your code with customizable build systems +* Run programs without leaving the editor +* Integrated terminal for flexible command execution +* Lightweight, fast project manager UI +* Minimal configuration with extensibility in mind -- ๐Ÿ“‚ **Create New Projects**: Start fresh with ease. -- ๐Ÿ“ **Generate New Files**: Add files to your projects with just a few keystrokes. -- โš™๏ธ **Build Your Files**: Compile and prepare your projects directly within Neovim. -- ๐ŸŽฎ **Run Your Code**: Execute your code and see results without leaving your terminal. -- ๐Ÿ–ฅ๏ธ **Built-in Terminal**: A terminal integrated directly into Neovim for running commands, scripts, or code. -- ๐Ÿ–ฅ๏ธ **Built-in Project Manager**: A window integrated directly into Neovim for creating projects, files, deleting files, renaming files and more. -- ๐ŸŒฑ **More to Come**: Ongoing development means new features and improvements are always on the horizon! - -**Need more info?** Check out the full [Polydev Documentation](https://darthmoomancer.github.io/Polydev/) for setup instructions, configurations, and usage details. +> ๐Ÿ“š [View the full documentation](https://darthmoomancer.github.io/Polydev/) for setup, configuration, and usage details. --- -## โœ… **Currently Supported (And Working) Languages** +## Supported Languages -Polydev supports a wide range of languages, providing a smooth development experience: +Polydev currently supports the following languages: -- **Java** โ˜•๏ธ -- **Python** ๐Ÿ -- **C/C++** ๐Ÿ’ป -- **Lua** ๐Ÿข -- **Rust** ๐Ÿฆ€ -- **HTML** ๐ŸŒ +* Java +* Python +* C / C++ +* Lua +* Rust +* HTML -And more on the way! Stay tuned for future updates. +Additional language support is planned for future releases. --- -## ๐Ÿ”ฎ **Planned Features** +## Roadmap -I am always working to make Polydev better. Hereโ€™s a sneak peek at some exciting plans: - -- Nothing. Just refactoring rn +Current focus: +-- **Refactoring and internal cleanup.** +Feature additions will resume after this phase. --- -## ๐Ÿค **Questions and Contributing** +## Contributing -Got ideas? ๐Ÿ’ก Have a feature youโ€™d love to see or a language you want to see supported? Your contributions are always welcome! Here's how you can get involved: +Contributions are welcome and appreciated. -- ๐Ÿ”ง **Contribute**: Open a Pull Request (PR) or create an issue with your suggestions or bug reports. -- ๐Ÿ’ฌ **Ask Questions**: If you're stuck or have questions, drop them in the issues or discussions section, and I'll get back to you as soon as I can. +* Open an issue for bug reports, questions, or feature requests. +* Submit a pull request if you'd like to contribute directly. +If you have an idea or use case you'd like to see supported, letโ€™s discuss it. Your feedback and contributions are key to making Polydev even better! Thank you for being part of the journey. ๐Ÿ™ ---