From 89fc47d744f90d043a18b11b62c2eedd514b0875 Mon Sep 17 00:00:00 2001 From: JinmingYang <2214962083@qq.com> Date: Mon, 8 Jul 2024 23:34:30 +0800 Subject: [PATCH] docs: update readme --- README.md | 14 ++++++++++---- README_CN.md | 14 ++++++++++---- 2 files changed, 20 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 8c71856..cb8dfee 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,11 @@ Master Any Code: One-Click Comments and Language Conversion. 💪 3. Search for "[Aide](https://marketplace.visualstudio.com/items?itemName=nicepkg.aide-pro)" 4. Click Install -## Usage 🛠 +## Configuration 🛠 + +See: [Document](https://github.com/nicepkg/aide/tree/master/docs/configuration/README.md) + +## Usage 🚀 ### 1. Aide: Code Convert @@ -83,11 +87,13 @@ Assign custom keyboard shortcuts to these commands for faster access: Enhance your productivity with Aide's AI-powered features. Install now and experience a smarter way to code! -**For more, see: [Document](https://github.com/nicepkg/aide/tree/master/docs/configuration/README.md)** +## ChangeLog 📅 + +See the [CHANGELOG](https://github.com/nicepkg/aide/blob/master/CHANGELOG.md) for the latest updates. ## Contributing 🤝 -Contributions are welcome! Please feel free to submit a Pull Request. See the [contributing guide](CONTRIBUTING.md) for more details. +Contributions are welcome! Please feel free to submit a Pull Request. See the [contributing guide](https://github.com/nicepkg/aide/blob/master/CONTRIBUTING.md) for more details. This project exists thanks to all the people who contribute: @@ -97,7 +103,7 @@ This project exists thanks to all the people who contribute: ## License 📄 -This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. +This project is licensed under the MIT License - see the [LICENSE](https://github.com/nicepkg/aide/blob/master/LICENSE) file for details. ## Support 💖 diff --git a/README_CN.md b/README_CN.md index a0fa461..dfac82f 100644 --- a/README_CN.md +++ b/README_CN.md @@ -32,7 +32,11 @@ 3. 搜索 “[Aide](https://marketplace.visualstudio.com/items?itemName=nicepkg.aide-pro)” 4. 点击安装 -## 用法 🛠 +## 配置 🛠 + +查看:[文档](https://github.com/nicepkg/aide/tree/master/docs/configuration/README_CN.md) + +## 用法 🚀 ### 1. Aide: 代码转换 @@ -81,11 +85,13 @@ 通过 Aide 的 AI 驱动功能提升您的工作效率。立即安装,体验更智能的编码方式! -**更多信息,请参见:[文档](https://github.com/nicepkg/aide/tree/master/docs/configuration/README_CN.md)** +## 更新日志 📅 + +查看最新的更新和功能:[更新日志](https://github.com/nicepkg/aide/blob/master/CHANGELOG.md) ## 贡献 🤝 -欢迎贡献!请随时提交拉取请求。有关详细信息,请参阅 [贡献指南](CONTRIBUTING.md)。 +欢迎贡献!请随时提交拉取请求。有关详细信息,请参阅 [贡献指南](https://github.com/nicepkg/aide/blob/master/CONTRIBUTING.md)。 这个项目的存在感谢所有贡献者: @@ -95,7 +101,7 @@ ## 许可证 📄 -此项目根据 MIT 许可证授权 - 有关详细信息,请参阅 [LICENSE](LICENSE) 文件。 +此项目根据 MIT 许可证授权 - 有关详细信息,请参阅 [LICENSE](https://github.com/nicepkg/aide/blob/master/LICENSE) 文件。 ## 支持 💖