|
29 | 29 | [<img src="https://img.shields.io/badge/立刻使用-ffd91c?logo=cloudflarepages&style=for-the-badge&logoColor=000000" width="170"/>](https://abra.halu.ca/) |
30 | 30 | [<img src="https://img.shields.io/badge/下载插件-8a54ff?logo=googlechrome&style=for-the-badge&logoColor=ffffff" width="170" />](#浏览器插件) |
31 | 31 |
|
| 32 | +[<img src="https://img.shields.io/badge/项目完整文档-54ffac?style=for-the-badge" width="120" />](https://doc.abra.halu.ca) |
32 | 33 | [<img src="https://img.shields.io/badge/前端源码仓库-9a10b5?style=for-the-badge" width="120" />](https://github.com/SheepChef/Abracadabra_demo) |
33 | | -[<img src="https://img.shields.io/badge/贡献压缩字典-54ffac?style=for-the-badge" width="120" />](https://forms.gle/BBD5McqU6Bws6hiw6) |
34 | 34 | [<img src="https://img.shields.io/badge/更新频道-0970ba?logo=telegram&style=for-the-badge&logoColor=ffffff" width="118" />](https://t.me/abracadabra_cn) |
35 | 35 |
|
36 | 36 | </div> |
|
41 | 41 | --- |
42 | 42 |
|
43 | 43 | ✨ 查阅 [**快速使用**](#快速使用) 一节,以开始使用/部署本项目。 |
44 | | -✨ 查阅 [**细节和使用指南**](https://github.com/SheepChef/Abracadabra/blob/main/USAGE.md) 以深入了解本项目的细节。 |
| 44 | +✨ 查阅 [**项目文档**](https://doc.abra.halu.ca),快速开始使用本项目。 |
45 | 45 |
|
46 | 46 | 👉 查阅 [**开放源代码许可**](#开放源代码许可) 一节,了解本项目的依赖项和许可证。 |
47 | 47 |
|
|
82 | 82 |
|
83 | 83 | ## 快速使用 |
84 | 84 |
|
85 | | -开发者请查阅 [**部署指南**](DEPLOY.md) 来了解详细部署方法。 |
| 85 | +开发者请查阅 [**项目文档**](https://doc.abra.halu.ca) 来了解详细部署方法。 |
86 | 86 | 要部署前端网页,请查阅 Release 和前端源代码仓库。 |
87 | 87 |
|
88 | 88 | 如果你是普通用户,请参考本文下方的内容。 |
89 | 89 |
|
90 | | -### JavaScript |
91 | | - |
92 | | -使用 npm 下载 Abracadabra 库。 |
93 | | - |
94 | | -你也可以前往 Release 页面直接下载Js文件。 |
95 | | - |
96 | | -```shell |
97 | | -npm install abracadabra-cn |
98 | | -``` |
99 | | - |
100 | | -然后,在项目中引入库文件 |
101 | | - |
102 | | -```javascript |
103 | | -import { Abracadabra } from "abracadabra-cn"; |
104 | | -``` |
105 | | - |
106 | | -### WebAssembly |
107 | | - |
108 | | -前往 Release 下载编译好的 WebAssembly 文件。 |
109 | | - |
110 | | -然后,使用 [**wasmtime**](https://github.com/bytecodealliance/wasmtime) 来调用它。 |
111 | | - |
112 | | -```shell |
113 | | - |
114 | | -echo '{"method":"NEXT","mode":"ENCRYPT","inputType":"TEXT","outputType":"TEXT","input":"愿青空的祝福,与我的羽翼同在","key":"ABRACADABRA","q":true,"r":50,"p":false,"l":false}' | wasmtime abracadabra-cn.wasm |
115 | | - |
116 | | -``` |
117 | | - |
118 | | -本项目的 WebAssembly 模块使用 [**Javy**](https://github.com/bytecodealliance/javy) 编译而来,方便在 C++、Rust、Go 等语言中调用,**不推荐**在类似 Python、 Java、Node.js 的解释器中调用。 |
119 | | - |
120 | | -要调用本 WebAssembly 模块,需要使用尚在预览状态的 [**WASI**](https://github.com/WebAssembly/WASI),目前仅有 wasmtime 提供了最完整的 WASI 支持,但它在各个语言的实现并不一致,具体请见 [**部署指南**](DEPLOY.md)。 |
121 | | - |
122 | 90 | ### 静态页面 / 前端源码 |
123 | 91 |
|
124 | 92 | 本项目有自动托管在Cloudflare Pages的静态页面可供直接使用。 |
@@ -158,7 +126,7 @@ APK文件可以 [**在 Release 中下载**](https://github.com/SheepChef/Abracad |
158 | 126 |
|
159 | 127 | ## 细节概要 |
160 | 128 |
|
161 | | -请查阅 [**细节和使用指南**](https://github.com/SheepChef/Abracadabra/blob/main/USAGE.md) 了解更多。 |
| 129 | +请查阅 [**项目文档**](https://doc.abra.halu.ca) 了解更多。 |
162 | 130 |
|
163 | 131 | [](https://deepwiki.com/SheepChef/Abracadabra) |
164 | 132 |
|
|
0 commit comments