📝 Update README.md

johnmai-dev · Oct 5, 2024 · ad46de4 · ad46de4
1 parent 10e08c3
commit ad46de4
Show file tree

Hide file tree

Showing 2 changed files with 71 additions and 4 deletions.
diff --git a/README-zh_CN.md b/README-zh_CN.md
@@ -2,7 +2,6 @@
 
 [English](./README.md) | 简体中文
 
-
 [![贡献者][contributors-shield]][contributors-url]
 [![分支数][forks-shield]][forks-url]
 [![星标数][stars-shield]][stars-url]
@@ -46,19 +45,52 @@
 
 ![iShot_2024-08-31_23.55.39.png](images/iShot_2024-08-31_23.55.39.png)
 
+## 参与贡献 🤝
+
+我们非常欢迎各种形式的贡献。如果你对贡献 ChatMLX 感兴趣，可以大展身手，向我们展示你的奇思妙想。
+
+[![][github-contrib-shield]][github-contrib-link]
+
+## Links 🌐
+
+- [MLX Swift](https://github.com/ml-explore/mlx-swift) - [MLX](https://github.com/ml-explore/mlx)的Swift API
+- [Transformers Swift](https://github.com/huggingface/swift-transformers) -
+  在Swift中实现类似于[transformers](https://github.com/huggingface/transformers)的API的Swift包
+- [Jinja Swift](https://github.com/maiqingqiang/Jinja) - 一个简约的 Swift
+  实现 [Jinja](https://jinja.palletsprojects.com/en/3.1.x/) 模板引擎，专门用于解析和渲染 ML 聊天模板。
+
 ## Star 历史 🌟
 
 [![星标历史图表](https://api.star-history.com/svg?repos=maiqingqiang/ChatMLX&type=Date)](https://star-history.com/#maiqingqiang/ChatMLX&Date)
 
+<div align="right">
+
+[![][back-to-top]](#readme-top)
+
+</div>
+
 [contributors-shield]: https://img.shields.io/github/contributors/maiqingqiang/ChatMLX.svg?style=for-the-badge
+
 [contributors-url]: https://github.com/maiqingqiang/ChatMLX/graphs/contributors
+
 [forks-shield]: https://img.shields.io/github/forks/maiqingqiang/ChatMLX.svg?style=for-the-badge
+
 [forks-url]: https://github.com/maiqingqiang/ChatMLX/network/members
+
 [stars-shield]: https://img.shields.io/github/stars/maiqingqiang/ChatMLX.svg?style=for-the-badge
+
 [stars-url]: https://github.com/maiqingqiang/ChatMLX/stargazers
+
 [issues-shield]: https://img.shields.io/github/issues/maiqingqiang/ChatMLX.svg?style=for-the-badge
+
 [issues-url]: https://github.com/maiqingqiang/ChatMLX/issues
+
 [license-shield]: https://img.shields.io/github/license/maiqingqiang/ChatMLX.svg?style=for-the-badge
+
 [license-url]: https://github.com/maiqingqiang/ChatMLX/blob/main/LICENSE
 
-<p align ="right">( < a href="#readme-top ">返回顶部< / a > )< p >
+[github-contrib-link]: https://github.com/maiqingqiang/ChatMLX/graphs/contributors
+
+[github-contrib-shield]: https://contrib.rocks/image?repo=maiqingqiang/ChatMLX
+
+[back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square
diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@ English | [简体中文](./README-zh_CN.md)
     <img src="ChatMLX/Assets.xcassets/AppIcon.appiconset/1024.png" alt="Logo" width="80" height="80">
   </a>
 
-  <h3 align="center">ChatMLX</h3>
+<h3 align="center">ChatMLX</h3>
 
   <p align="center">
     ChatMLX is a modern, open-source, high-performance chat application for MacOS based on large language models, based on the powerful performance of <a href="https://github.com/ml-explore/mlx-swift">MLX</a> and Apple silicon. It supports multiple models, providing users with a rich variety of conversation options. It runs LLM locally to ensure user privacy and security.
@@ -45,19 +45,54 @@ https://github.com/user-attachments/assets/75984252-058f-4782-ad5d-33b3ce772639
 
 ![iShot_2024-08-31_23.55.39.png](images/iShot_2024-08-31_23.55.39.png)
 
+## 参与贡献 🤝
+
+Contributions of all types are more than welcome, if you are interested in contributing ChatMLX, feel free to show us
+what you’re made of.
+
+[![][github-contrib-shield]][github-contrib-link]
+
+## Links 🌐
+
+- [MLX Swift](https://github.com/ml-explore/mlx-swift) - Swift API for [MLX](https://github.com/ml-explore/mlx)
+- [Transformers Swift](https://github.com/huggingface/swift-transformers) - Swift Package to implement
+  a [transformers](https://github.com/huggingface/transformers)-like API in Swift
+- [Jinja Swift](https://github.com/maiqingqiang/Jinja) - A minimalistic Swift implementation of
+  the [Jinja](https://jinja.palletsprojects.com/en/3.1.x/) templating engine, specifically designed for parsing and
+  rendering ML chat templates.
+
 ## Star History 🌟
 
 [![Star History Chart](https://api.star-history.com/svg?repos=maiqingqiang/ChatMLX&type=Date)](https://star-history.com/#maiqingqiang/ChatMLX&Date)
 
+<div align="right">
+
+[![][back-to-top]](#readme-top)
+
+</div>
+
 [contributors-shield]: https://img.shields.io/github/contributors/maiqingqiang/ChatMLX.svg?style=for-the-badge
+
 [contributors-url]: https://github.com/maiqingqiang/ChatMLX/graphs/contributors
+
 [forks-shield]: https://img.shields.io/github/forks/maiqingqiang/ChatMLX.svg?style=for-the-badge
+
 [forks-url]: https://github.com/maiqingqiang/ChatMLX/network/members
+
 [stars-shield]: https://img.shields.io/github/stars/maiqingqiang/ChatMLX.svg?style=for-the-badge
+
 [stars-url]: https://github.com/maiqingqiang/ChatMLX/stargazers
+
 [issues-shield]: https://img.shields.io/github/issues/maiqingqiang/ChatMLX.svg?style=for-the-badge
+
 [issues-url]: https://github.com/maiqingqiang/ChatMLX/issues
+
 [license-shield]: https://img.shields.io/github/license/maiqingqiang/ChatMLX.svg?style=for-the-badge
+
 [license-url]: https://github.com/maiqingqiang/ChatMLX/blob/main/LICENSE
 
-<p align="right">(<a href="#readme-top">back to top</a>)</p>
+[github-contrib-link]: https://github.com/maiqingqiang/ChatMLX/graphs/contributors
+
+[github-contrib-shield]: https://contrib.rocks/image?repo=maiqingqiang/ChatMLX
+
+[back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square