feat: add ecosystem

ohos-rs · Mar 6, 2024 · 6d96785 · 6d96785
1 parent 7fc1c5f
commit 6d96785
Show file tree

Hide file tree

Showing 3 changed files with 54 additions and 2 deletions.
diff --git a/.vitepress/config.mts b/.vitepress/config.mts
@@ -20,27 +20,39 @@ export default defineConfig({
         sidebar: [
             {
                 text: 'Basic',
+
                 items: [
                     {text: 'Quick Start', link: '/basic/quick-start'},
                     {text: 'Simple Project', link: '/basic/simple-project'},
                 ]
             },
             {
                 text: 'Cli',
+                collapsed: false,
                 items: [
                     {text: 'Init', link: "/cli/init"},
                     {text: 'Build', link: "/cli/build"},
                 ]
             },
             {
                 text: 'Usage',
+                collapsed: false,
+                items: [
+                    {text: 'Basic', link: "/usage/basic"},
+                    {text: 'Task', link: "/usage/task"},
+                    {text: 'ThreadSafeFunction',link: "/usage/tsfn"}
+                ]
+            },
+            {
+                text: 'Ecosystem',
+                collapsed: false,
                 items: [
-                    {text: 'Basic', link: "/usage/basic.md"},
-                    {text: 'Task', link: "/usage/task.md"},
+                    {text: '@ohos-rs/crc32',link: "/ecosystem/crc32"}
                 ]
             },
             {
                 text: 'CD/CD',
+                collapsed: false,
                 items: [
                     {text: 'CI', link: "/ci/basic.md"},
                 ]

diff --git a/src/ecosystem/crc32.md b/src/ecosystem/crc32.md
@@ -0,0 +1,33 @@
+---
+editLink: true
+---
+
+# @ohos-rs/crc32
+
+The fast implement crc32 in HarmonyOS using SIMD.
+
+## Requirement
+
+- NDK Version >= 10
+
+## Install
+
+```shell
+ohpm install @ohos-rs/crc32
+```
+
+## Api
+
+```ts
+export function crc32(input: string | buffer.Buffer, crc?: number): number
+export function crc32c(input: string | buffer.Buffer, crc?: number): number
+```
+
+## Usage
+
+```ts
+import { crc32 } from '@ohos-rs/crc32';
+
+crc32("crc32c - test",0);
+// 2608757237
+```
diff --git a/src/usage/tsfn.md b/src/usage/tsfn.md
@@ -0,0 +1,7 @@
+---
+editLink: true
+---
+
+# ThreadSafeFunction
+
+todo