diff --git a/README.md b/README.md index dfb637b..49ac3d2 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,58 @@ -# Polydev -A multi-lingual plugin that adds some nice features to neovim for managing, creating, building and runnning projects all within neovim. +# **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-c](https://github.com/user-attachments/assets/365dd673-6b1f-4ccc-ac1f-c5131d055fd9) -### Quick Features -The ability to - -* Create new projects -* Create new files -* Build those files -* Run those files -* Builtin terminal for running code -* And More! +--- -Documentation is over at [Polydev Documentation](https://darthmoomancer.github.io/Polydev/) +## ๐Ÿš€ **Quick Features** -### Currently Supported (And working) Languages -* Java -* Python -* C/C++ -* Lua -* Rust -* Html +Polydev helps you work smarter, not harder. With this plugin, you can: -## Things planned -* The use of rust to speed up some aspects of the plugin -## Questions and Contributing +- ๐Ÿ“‚ **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. +- ๐ŸŒฑ **More to Come**: Ongoing development means new features and improvements are always on the horizon! -If you want to contribute, make a PR or issue and I will answer as soon as I see it. If there is a language that you want added for easier use, please voice it. If you have questions, just ask in issues or discussions and I will answer them. +**Need more info?** Check out the full [Polydev Documentation](https://darthmoomancer.github.io/Polydev/) for setup instructions, configurations, and usage details. + +--- + +## โœ… **Currently Supported (And Working) Languages** + +Polydev supports a wide range of languages, providing a smooth development experience: + +- **Java** โ˜•๏ธ +- **Python** ๐Ÿ +- **C/C++** ๐Ÿ’ป +- **Lua** ๐Ÿข +- **Rust** ๐Ÿฆ€ +- **HTML** ๐ŸŒ + +And more on the way! Stay tuned for future updates. + +--- + +## ๐Ÿ”ฎ **Planned Features** + +We're always working to make Polydev better. Hereโ€™s a sneak peek at some exciting plans: + +- ๐Ÿš€ **Rust Integration**: Leverage Rust to speed up certain aspects of the plugin for faster performance and better scalability. + +--- + +## ๐Ÿค **Questions and 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: + +- ๐Ÿ”ง **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. + +Your feedback and contributions are key to making Polydev even better! Thank you for being part of the journey. ๐Ÿ™ + +--- + +Feel free to customize it further as needed!