Skip to content

Commit ad46de4

Browse files
committed
📝 Update README.md
1 parent 10e08c3 commit ad46de4

File tree

2 files changed

+71
-4
lines changed

2 files changed

+71
-4
lines changed

README-zh_CN.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
[English](./README.md) | 简体中文
44

5-
65
[![贡献者][contributors-shield]][contributors-url]
76
[![分支数][forks-shield]][forks-url]
87
[![星标数][stars-shield]][stars-url]
@@ -46,19 +45,52 @@
4645

4746
![iShot_2024-08-31_23.55.39.png](images/iShot_2024-08-31_23.55.39.png)
4847

48+
## 参与贡献 🤝
49+
50+
我们非常欢迎各种形式的贡献。如果你对贡献 ChatMLX 感兴趣,可以大展身手,向我们展示你的奇思妙想。
51+
52+
[![][github-contrib-shield]][github-contrib-link]
53+
54+
## Links 🌐
55+
56+
- [MLX Swift](https://github.com/ml-explore/mlx-swift) - [MLX](https://github.com/ml-explore/mlx)的Swift API
57+
- [Transformers Swift](https://github.com/huggingface/swift-transformers) -
58+
在Swift中实现类似于[transformers](https://github.com/huggingface/transformers)的API的Swift包
59+
- [Jinja Swift](https://github.com/maiqingqiang/Jinja) - 一个简约的 Swift
60+
实现 [Jinja](https://jinja.palletsprojects.com/en/3.1.x/) 模板引擎,专门用于解析和渲染 ML 聊天模板。
61+
4962
## Star 历史 🌟
5063

5164
[![星标历史图表](https://api.star-history.com/svg?repos=maiqingqiang/ChatMLX&type=Date)](https://star-history.com/#maiqingqiang/ChatMLX&Date)
5265

66+
<div align="right">
67+
68+
[![][back-to-top]](#readme-top)
69+
70+
</div>
71+
5372
[contributors-shield]: https://img.shields.io/github/contributors/maiqingqiang/ChatMLX.svg?style=for-the-badge
73+
5474
[contributors-url]: https://github.com/maiqingqiang/ChatMLX/graphs/contributors
75+
5576
[forks-shield]: https://img.shields.io/github/forks/maiqingqiang/ChatMLX.svg?style=for-the-badge
77+
5678
[forks-url]: https://github.com/maiqingqiang/ChatMLX/network/members
79+
5780
[stars-shield]: https://img.shields.io/github/stars/maiqingqiang/ChatMLX.svg?style=for-the-badge
81+
5882
[stars-url]: https://github.com/maiqingqiang/ChatMLX/stargazers
83+
5984
[issues-shield]: https://img.shields.io/github/issues/maiqingqiang/ChatMLX.svg?style=for-the-badge
85+
6086
[issues-url]: https://github.com/maiqingqiang/ChatMLX/issues
87+
6188
[license-shield]: https://img.shields.io/github/license/maiqingqiang/ChatMLX.svg?style=for-the-badge
89+
6290
[license-url]: https://github.com/maiqingqiang/ChatMLX/blob/main/LICENSE
6391

64-
<p align ="right">( < a href="#readme-top ">返回顶部< / a > )< p >
92+
[github-contrib-link]: https://github.com/maiqingqiang/ChatMLX/graphs/contributors
93+
94+
[github-contrib-shield]: https://contrib.rocks/image?repo=maiqingqiang/ChatMLX
95+
96+
[back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square

README.md

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ English | [简体中文](./README-zh_CN.md)
1515
<img src="ChatMLX/Assets.xcassets/AppIcon.appiconset/1024.png" alt="Logo" width="80" height="80">
1616
</a>
1717

18-
<h3 align="center">ChatMLX</h3>
18+
<h3 align="center">ChatMLX</h3>
1919

2020
<p align="center">
2121
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
4545

4646
![iShot_2024-08-31_23.55.39.png](images/iShot_2024-08-31_23.55.39.png)
4747

48+
## 参与贡献 🤝
49+
50+
Contributions of all types are more than welcome, if you are interested in contributing ChatMLX, feel free to show us
51+
what you’re made of.
52+
53+
[![][github-contrib-shield]][github-contrib-link]
54+
55+
## Links 🌐
56+
57+
- [MLX Swift](https://github.com/ml-explore/mlx-swift) - Swift API for [MLX](https://github.com/ml-explore/mlx)
58+
- [Transformers Swift](https://github.com/huggingface/swift-transformers) - Swift Package to implement
59+
a [transformers](https://github.com/huggingface/transformers)-like API in Swift
60+
- [Jinja Swift](https://github.com/maiqingqiang/Jinja) - A minimalistic Swift implementation of
61+
the [Jinja](https://jinja.palletsprojects.com/en/3.1.x/) templating engine, specifically designed for parsing and
62+
rendering ML chat templates.
63+
4864
## Star History 🌟
4965

5066
[![Star History Chart](https://api.star-history.com/svg?repos=maiqingqiang/ChatMLX&type=Date)](https://star-history.com/#maiqingqiang/ChatMLX&Date)
5167

68+
<div align="right">
69+
70+
[![][back-to-top]](#readme-top)
71+
72+
</div>
73+
5274
[contributors-shield]: https://img.shields.io/github/contributors/maiqingqiang/ChatMLX.svg?style=for-the-badge
75+
5376
[contributors-url]: https://github.com/maiqingqiang/ChatMLX/graphs/contributors
77+
5478
[forks-shield]: https://img.shields.io/github/forks/maiqingqiang/ChatMLX.svg?style=for-the-badge
79+
5580
[forks-url]: https://github.com/maiqingqiang/ChatMLX/network/members
81+
5682
[stars-shield]: https://img.shields.io/github/stars/maiqingqiang/ChatMLX.svg?style=for-the-badge
83+
5784
[stars-url]: https://github.com/maiqingqiang/ChatMLX/stargazers
85+
5886
[issues-shield]: https://img.shields.io/github/issues/maiqingqiang/ChatMLX.svg?style=for-the-badge
87+
5988
[issues-url]: https://github.com/maiqingqiang/ChatMLX/issues
89+
6090
[license-shield]: https://img.shields.io/github/license/maiqingqiang/ChatMLX.svg?style=for-the-badge
91+
6192
[license-url]: https://github.com/maiqingqiang/ChatMLX/blob/main/LICENSE
6293

63-
<p align="right">(<a href="#readme-top">back to top</a>)</p>
94+
[github-contrib-link]: https://github.com/maiqingqiang/ChatMLX/graphs/contributors
95+
96+
[github-contrib-shield]: https://contrib.rocks/image?repo=maiqingqiang/ChatMLX
97+
98+
[back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square

0 commit comments

Comments
 (0)