Skip to content

Commit

Permalink
feat: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
xsf0105 committed Aug 20, 2024
1 parent 28366bb commit 23acf79
Show file tree
Hide file tree
Showing 6 changed files with 46 additions and 27 deletions.
25 changes: 12 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
<h2 align="center"> Quarkc </h2>
<div align="center">
Quarkc 无框架,前端构建工具。
</div>
<div align="center">
已支撑哈啰几乎所有 C 端 / B 端项目,包括交易,支付,两轮,商城等。
</div>
<p align="center">
<a href="https://quark-ecosystem.github.io/quarkc-docs/#/"><img src="./logo.png" width="180" alt="vite-plugin-dev-inspector"></a>
</p>

<h2 align="center"> Quarkc —— 无框架,跨框架! </h2>

<p align="center">
<a href="https://www.npmjs.com/package/quarkc"><img src="https://img.shields.io/npm/dt/quarkc.svg" alt="Total Downloads"></a>
Expand Down Expand Up @@ -32,12 +30,12 @@ Quarkc(Quark core缩写) 是一个拥有完美开发体验的 web components 工

### 特性

* **跨技术栈**组件可以在任何框架或无框架的环境下使用,让你的代码更具复用性
* **组件体积极小,性能极高**:因为 Quarkc 使用的是浏览器原生 API,所以你的组件可以达到最优性能,且体积小巧
* 无框架,组件可以在任何框架或无框架的环境下使用,让你的代码更具复用性
* 产物体积极小,性能接近浏览器原生元素
* Web Components, Simple, Fast!
* 浏览器原生API,组件可以跨技术栈使用
* 没有前端框架 Runtime,Web 组件体积小到极致
* **高性能**设计,Shadow DOM 与 Virtual DOM 融合
* Shadow DOM 与 Virtual DOM 的完美融合
* 组件直接解耦,独立打磨,按需引用


Expand Down Expand Up @@ -169,14 +167,12 @@ export default defineConfig({

## 文档

完整文档,请访问 [quarkc.hellobike.com](https://quark-ecosystem.github.io/quarkc-docs)

完整文档,请访问 [https://quark-ecosystem.github.io/quarkc-docs](https://quark-ecosystem.github.io/quarkc-docs)

### 联系我们

添加微信:Sanqi9675


### 社区示例

| 作者 | github 地址 | 截图 / 链接
Expand All @@ -189,3 +185,6 @@ export default defineConfig({
| @zhangfisher | https://github.com/zhangfisher/lite-tree/tree/master/packages/quark | [点击查看](https://github.com/zhangfisher/lite-tree/blob/master/docs/tree.png?raw=true) |


## License

[MIT LICENSE](./LICENSE)
Binary file added logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions packages/core/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 哈啰大前端

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
25 changes: 12 additions & 13 deletions packages/core/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
<h2 align="center"> Quarkc </h2>
<div align="center">
Quarkc 无框架,前端构建工具。
</div>
<div align="center">
已支撑哈啰几乎所有 C 端 / B 端项目,包括交易,支付,两轮,商城等。
</div>
<p align="center">
<a href="https://quark-ecosystem.github.io/quarkc-docs/#/"><img src="./logo.png" width="180" alt="vite-plugin-dev-inspector"></a>
</p>

<h2 align="center"> Quarkc —— 无框架,跨框架! </h2>

<p align="center">
<a href="https://www.npmjs.com/package/quarkc"><img src="https://img.shields.io/npm/dt/quarkc.svg" alt="Total Downloads"></a>
Expand Down Expand Up @@ -32,12 +30,12 @@ Quarkc(Quark core缩写) 是一个拥有完美开发体验的 web components 工

### 特性

* **跨技术栈**组件可以在任何框架或无框架的环境下使用,让你的代码更具复用性
* **组件体积极小,性能极高**:因为 Quarkc 使用的是浏览器原生 API,所以你的组件可以达到最优性能,且体积小巧
* 无框架,组件可以在任何框架或无框架的环境下使用,让你的代码更具复用性
* 产物体积极小,性能接近浏览器原生元素
* Web Components, Simple, Fast!
* 浏览器原生API,组件可以跨技术栈使用
* 没有前端框架 Runtime,Web 组件体积小到极致
* **高性能**设计,Shadow DOM 与 Virtual DOM 融合
* Shadow DOM 与 Virtual DOM 的完美融合
* 组件直接解耦,独立打磨,按需引用


Expand Down Expand Up @@ -169,14 +167,12 @@ export default defineConfig({

## 文档

完整文档,请访问 [quarkc.hellobike.com](https://quark-ecosystem.github.io/quarkc-docs)

完整文档,请访问 [https://quark-ecosystem.github.io/quarkc-docs](https://quark-ecosystem.github.io/quarkc-docs)

### 联系我们

添加微信:Sanqi9675


### 社区示例

| 作者 | github 地址 | 截图 / 链接
Expand All @@ -189,3 +185,6 @@ export default defineConfig({
| @zhangfisher | https://github.com/zhangfisher/lite-tree/tree/master/packages/quark | [点击查看](https://github.com/zhangfisher/lite-tree/blob/master/docs/tree.png?raw=true) |


## License

[MIT LICENSE](./LICENSE)
Binary file added packages/core/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion packages/core/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "quarkc",
"version": "2.1.8",
"version": "2.1.9",
"description": "A Web Components framework",
"type": "module",
"module": "./lib/index.js",
Expand Down

0 comments on commit 23acf79

Please sign in to comment.