update readme

Author: CppCXY

CONTRIBUTING.md

@@ -0,0 +1,93 @@
+# Contributing Guide
+
+Thank you for your interest in the EmmyLua2 project! We welcome contributions of all kinds.
+
+## 🚀 How to Contribute
+
+### Reporting Bugs
+
+If you find a bug, please:
+
+1. Check [Issues](https://github.com/CppCXY/Intellij-EmmyLua2/issues) to ensure the issue hasn't been reported
+2. Create a new Issue including:
+   - Detailed problem description
+   - Steps to reproduce
+   - Expected behavior vs actual behavior
+   - Environment information (IDE version, OS, etc.)
+   - Relevant screenshots or logs
+
+### Feature Suggestions
+
+For new feature suggestions:
+
+1. Discuss your idea in [Discussions](https://github.com/CppCXY/Intellij-EmmyLua2/discussions)
+2. If you get positive feedback, create a Feature Request Issue
+
+### Code Contributions
+
+1. **Fork the project**
+2. **Create a feature branch**
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+3. **Commit changes**
+   ```bash
+   git commit -m "feat: add new feature description"
+   ```
+4. **Push to branch**
+   ```bash
+   git push origin feature/your-feature-name
+   ```
+5. **Create Pull Request**
+
+## 📝 Code Standards
+
+### Commit Message Format
+
+Use [Conventional Commits](https://www.conventionalcommits.org/) format:
+
+```
+<type>[optional scope]: <description>
+
+[optional body]
+
+[optional footer(s)]
+```
+
+Types:
+- `feat`: New feature
+- `fix`: Bug fix
+- `docs`: Documentation update
+- `style`: Code formatting (no functional changes)
+- `refactor`: Refactoring
+- `test`: Test-related
+- `chore`: Build process or auxiliary tool changes
+
+### Code Style
+
+- Follow official Kotlin code style
+- Use meaningful variable and function names
+- Add appropriate comments
+- Ensure test coverage
+
+## 🧪 Testing
+
+Run tests:
+
+```bash
+./gradlew test
+```
+
+## 📚 Development Resources
+
+- [IntelliJ Platform SDK Documentation](https://plugins.jetbrains.com/docs/intellij/)
+- [Kotlin Programming Guide](https://kotlinlang.org/docs/)
+- [LSP Specification](https://microsoft.github.io/language-server-protocol/)
+
+## ❓ Need Help?
+
+- Check [FAQ](docs/faq.md)
+- Ask questions in [Discussions](https://github.com/CppCXY/Intellij-EmmyLua2/discussions)
+- Contact maintainers
+
+Thank you for your contributions! 🎉

README.md

@@ -1,17 +1,162 @@
-# Intellij-EmmyLua2
+# 🚀 EmmyLua2 for IntelliJ IDEA
 
-## MarketPlace
+<div align="center">
 
-https://plugins.jetbrains.com/plugin/25076-emmylua2
+[![JetBrains Plugin](https://img.shields.io/jetbrains/plugin/v/25076-emmylua2?style=for-the-badge&logo=jetbrains&logoColor=white&color=blue)](https://plugins.jetbrains.com/plugin/25076-emmylua2)
+[![Downloads](https://img.shields.io/jetbrains/plugin/d/25076-emmylua2?style=for-the-badge&color=green)](https://plugins.jetbrains.com/plugin/25076-emmylua2)
+[![Rating](https://img.shields.io/jetbrains/plugin/r/stars/25076-emmylua2?style=for-the-badge&color=yellow)](https://plugins.jetbrains.com/plugin/25076-emmylua2)
+[![License: MIT](https://img.shields.io/badge/License-MIT-purple.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)
 
-## Features
+**Modern Lua development plugin providing powerful Lua language support for IntelliJ IDEA**
 
-All Features come from [emmylua-analyzer-rust](https://github.com/CppCXY/emmylua-analyzer-rust)
+[📦 Install Plugin](https://plugins.jetbrains.com/plugin/25076-emmylua2) · [🐛 Report Issues](https://github.com/CppCXY/Intellij-EmmyLua2/issues) · [💡 Feature Requests](https://github.com/CppCXY/Intellij-EmmyLua2/discussions)
 
-## How to develop
+</div>
 
-1. Open this project with Intellij idea and wait sync
-2. Select and Run `buildPlugin` from gradle window
-3. Run `runide` from gradle
+## ✨ Features
+
+> Powered by the robust [emmylua-analyzer-rust](https://github.com/CppCXY/emmylua-analyzer-rust) engine
+
+### 🎯 Core Features
+- **Smart Code Completion** - Context-aware precise code suggestions
+- **Syntax Highlighting** - Support for Lua 5.1/5.2/5.3/5.4 syntax
+- **Error Detection** - Real-time syntax and semantic error reporting
+- **Code Navigation** - Quick jump to definitions, find references
+- **Refactoring Support** - Rename, extract variables and other refactoring operations
+
+### 🔧 Advanced Features
+- **EmmyLua Annotations Support** - Complete type annotation system
+- **Debugger Integration** - Built-in EmmyLua debugger
+- **Multi-platform Support** - Full support for Windows, macOS, Linux
+- **Performance Optimization** - High-performance language server based on Rust
+
+## 🛠️ Installation
+
+### Install from JetBrains Marketplace (Recommended)
+
+1. Open IntelliJ IDEA
+2. Go to `File` → `Settings` → `Plugins`
+3. Search for "EmmyLua2"
+4. Click `Install` to install the plugin
+5. Restart IDE
+
+### Manual Installation
+
+1. Download the latest version from [Releases](https://github.com/CppCXY/Intellij-EmmyLua2/releases)
+2. In IntelliJ IDEA, go to `File` → `Settings` → `Plugins`
+3. Click the gear icon → `Install Plugin from Disk...`
+4. Select the downloaded plugin file
+5. Restart IDE
+
+## 🚀 Quick Start
+
+### Create Lua Project
+
+1. `File` → `New` → `Project`
+2. Select `Lua` project type
+3. Configure project settings
+4. Start writing Lua code!
+
+### Configure EmmyLua Annotations
+
+```lua
+---@class Player
+---@field name string
+---@field level number
+local Player = {}
+
+---Create new player
+---@param name string Player name
+---@param level number Player level
+---@return Player
+function Player:new(name, level)
+    return setmetatable({
+        name = name,
+        level = level
+    }, { __index = self })
+end
+```
+
+## 🔧 Supported IDE Versions
+
+| IDE Version | Plugin Version | Status |
+|-------------|----------------|--------|
+| 2024.3+     | 0.8.x         | ✅ Actively Supported |
+
+## 🤝 Contributing
+
+We welcome contributions of all kinds! Please check the [Contributing Guide](CONTRIBUTING.md) to learn how to participate in the project.
+
+### Development Environment Setup
+
+#### 📋 Prerequisites
+
+- **JDK 17+** - Recommended to use OpenJDK or Oracle JDK
+- **IntelliJ IDEA 2024.3+** - Ultimate or Community Edition
+- **Git** - Version control tool
+
+#### 🔨 Build Steps
+
+1. **Clone Repository**
+   ```bash
+   git clone https://github.com/CppCXY/Intellij-EmmyLua2.git
+   cd Intellij-EmmyLua2
+   ```
+
+2. **Import Project**
+   - Open the project with IntelliJ IDEA
+   - Wait for Gradle sync to complete
+
+3. **Build Plugin**
+   ```bash
+   ./gradlew buildPlugin
+   ```
+
+4. **Run Development Environment**
+   ```bash
+   ./gradlew runIde
+   ```
+
+#### 🎯 Available Gradle Tasks
+
+| Task | Description |
+|------|-------------|
+| `buildPlugin` | Build plugin distribution package |
+| `runIde` | Run plugin in IDE sandbox |
+| `test` | Run test suite |
+| `downloadEmmyLuaAnalyzer` | Download Emmy Lua Analyzer |
+| `installDependencies` | Install all dependencies |
+| `cleanDependencies` | Clean downloaded dependencies |
+
+## 📊 Project Statistics
+
+<div align="center">
+
+![GitHub stars](https://img.shields.io/github/stars/CppCXY/Intellij-EmmyLua2?style=social)
+![GitHub forks](https://img.shields.io/github/forks/CppCXY/Intellij-EmmyLua2?style=social)
+![GitHub issues](https://img.shields.io/github/issues/CppCXY/Intellij-EmmyLua2)
+![GitHub pull requests](https://img.shields.io/github/issues-pr/CppCXY/Intellij-EmmyLua2)
+
+</div>
+
+## 🙏 Acknowledgments
+
+- [emmylua-analyzer-rust](https://github.com/CppCXY/emmylua-analyzer-rust) - Core language analysis engine
+- [EmmyLuaDebugger](https://github.com/EmmyLua/EmmyLuaDebugger) - Debugger support
+- [LSP4IJ](https://github.com/redhat-developer/lsp4ij) - LSP client implementation
+
+## 📄 License
+
+This project is open source under the [MIT License](LICENSE).
+
+---
+
+<div align="center">
+
+**⭐ If this project helps you, please give us a Star!**
+
+Made with ❤️ by [CppCXY](https://github.com/CppCXY)
+
+</div>