3.0.0

README.md

@@ -1,60 +1,48 @@
 # TSL Devkit
 
-该插件提供 `tsl` 语言的语法高亮以及`LSP`代码补全
+<p align="center">
+  <strong>🚀 TSL 语言开发工具套件</strong><br>
+  为主流编辑器提供完整的 TSL 语言支持
+</p>
 
-支持`LSP`需要安装`nodejs`
+<p align="center">
+  <img src="https://img.shields.io/badge/VSCode-supported-blue.svg" alt="VSCode">
+  <img src="https://img.shields.io/badge/Vim-supported-green.svg" alt="Vim">
+</p>
 
-## VSCode
+## 📖 简介
 
-### 安装方式一（推荐）
+TSL Devkit 是一套完整的 TSL 语言开发工具集，为开发者提供专业的编程体验。
 
-安装[vsix](./vscode/)扩展
+### ✨ 核心功能
 
-```bash
-code --install-extension tsl-tools-1.0.0.vsix  # 具体版本号以vsix文件为准
-```
+- 🎨 **语法高亮** - 智能代码着色，提升代码可读性
+- 🔧 **语言服务器 (LSP)** - 代码补全、错误诊断、跳转定义
+- 📝 **代码片段** - 常用代码模板，提高编码效率
 
-### 安装方式二
+## 🛠️ 支持的编辑器
 
-复制[vscode](./vscode)文件夹到`VSCode`扩展目录（建议更改文件夹名）
+### VSCode
 
-```txt
-Windows: %USERPROFILE%\.vscode\extensions
-macOS: ~/.vscode/extensions
-Linux: ~/.vscode/extensions
-```
+[查看 VSCode 指南](./vscode/README.md)
 
-### 安装方式三
+### Vim
 
-本项目`vscode`目录下执行
+[查看 Vim 指南](./vim/README.md)
 
-```bash
-npm install
-npx vsce package
+## 🤝 贡献
 
-# 安装
-code --install-extension tsl-tools-1.0.0.vsix # 具体版本号以vsix文件为准
-```
+我们欢迎各种形式的贡献！
 
-## Vim
+- 🐛 [报告 Bug](https://git.mytsl.cn/csh/tsl-devkit/issues)
+- 💡 [提出新功能](https://git.mytsl.cn/csh/tsl-devkit/issues)
+- 🔧 [提交 PR](https://git.mytsl.cn/csh/tsl-devkit/pulls)
+- 📖 [改进文档](https://git.mytsl.cn/csh/tsl-devkit/wiki)
 
-需要`vim 9.0`以上版本
+## 👥 维护者
 
-将[tsl.vim](./vim/tsl.vim)放入`~/.vim/syntax/`
+- [@csh](https://git.mytsl.cn/csh) - 项目作者
 
-```vim
-" vimrc加入，可同时支持tsl和tsf
-autocmd BufNewFile,BufRead *.ts[lf] setf tsl
-```
+## 🙏 致谢
 
-使用`LSP`，需要在你的`languageserver`设置相关的参数，以`coc.nvim`为例，需要在`coc-settings.json`设置如下内容
-
-```json
-"languageserver": {
-  "tsl-server": {
-    "command": "tsl-server",
-    "args": ["--log=trace", "--log=stderr"],
-    "filetypes": ["tsl", "tsf"]
-  }
-}
-```
+感谢所有为 TSL Devkit 做出贡献的开发者！