docs: move usage to example

mumu-lhl · Aug 17, 2024 · 3502cf6 · 3502cf6
1 parent c4731e7
commit 3502cf6
Show file tree

Hide file tree

Showing 4 changed files with 114 additions and 104 deletions.
diff --git a/README.md b/README.md
@@ -23,55 +23,4 @@ dart pub add dict_reader
 
 ## Usage
 
-### Read Data Directly
-
-```dart
-import 'package:dict_reader/dict_reader.dart';
-
-void main() async {
-  final dictReader = DictReader("MDX FILE PATH");
-  await dictReader.init();
-
-  await for (final (keyText, data) in dictReader.read(true)) {
-    print("$keyText, $data");
-  }
-}
-```
-
-### Read Data Offset, Read Data Later
-
-```dart
-import 'package:dict_reader/dict_reader.dart';
-
-void main() async {
-  final dictReader = DictReader("MDX FILE PATH");
-  await dictReader.init();
-
-  final map = <String, (int, int, int, int)>{};
-  await for (final (keyText, offset) in dictReader.read()) {
-    map[keyText] = offset;
-  }
-
-  final offset = map["go"];
-  print(await dictReader.readOne(offset!.$1, offset.$2, offset.$3, offset.$4));
-}
-```
-
-### Read Data After Stored Data Offset
-
-```dart
-import 'package:dict_reader/dict_reader.dart';
-
-// ...
-
-void main() async {
-  // ...
-
-  final dictReader = DictReader("MDX FILE PATH");
-  // Pass false to reduce initialization time
-  await dictReader.init(false);
-
-  final offset = map["go"];
-  print(await dictReader.readOne(offset!.$1, offset.$2, offset.$3, offset.$4));
-}
-```
+See [Example](./example/README.md).
diff --git a/README_CN.md b/README_CN.md
@@ -23,55 +23,4 @@ dart pub add dict_reader
 
 ## 使用
 
-### 直接读取数据
-
-```dart
-import 'package:dict_reader/dict_reader.dart';
-
-void main() async {
-  final dictReader = DictReader("MDX FILE PATH");
-  await dictReader.init();
-
-  await for (final (keyText, data) in dictReader.read(true)) {
-    print("$keyText, $data");
-  }
-}
-```
-
-### 读取数据 offset，之后读取数据
-
-```dart
-import 'package:dict_reader/dict_reader.dart';
-
-void main() async {
-  final dictReader = DictReader("MDX FILE PATH");
-  await dictReader.init();
-
-  final map = <String, (int, int, int, int)>{};
-  await for (final (keyText, offset) in dictReader.read()) {
-    map[keyText] = offset;
-  }
-
-  final offset = map["go"];
-  print(await dictReader.readOne(offset!.$1, offset.$2, offset.$3, offset.$4));
-}
-```
-
-### 当已保存数据 offset，读取数据
-
-```dart
-import 'package:dict_reader/dict_reader.dart';
-
-// ...
-
-void main() async {
-  // ...
-
-  final dictReader = DictReader("MDX FILE PATH");
-  // Pass false to reduce initialization time
-  await dictReader.init(false);
-
-  final offset = map["go"];
-  print(await dictReader.readOne(offset!.$1, offset.$2, offset.$3, offset.$4));
-}
-```
+见 [示例](./example/README_CN.md)。
diff --git a/example/README.md b/example/README.md
@@ -0,0 +1,56 @@
+# Example
+
+English | [中文](./README_CN.md)
+
+## Read Data Directly
+
+```dart
+import 'package:dict_reader/dict_reader.dart';
+
+void main() async {
+  final dictReader = DictReader("MDX FILE PATH");
+  await dictReader.init();
+
+  await for (final (keyText, data) in dictReader.read(true)) {
+    print("$keyText, $data");
+  }
+}
+```
+
+## Read Data Offset, Read Data Later
+
+```dart
+import 'package:dict_reader/dict_reader.dart';
+
+void main() async {
+  final dictReader = DictReader("MDX FILE PATH");
+  await dictReader.init();
+
+  final map = <String, (int, int, int, int)>{};
+  await for (final (keyText, offset) in dictReader.read()) {
+    map[keyText] = offset;
+  }
+
+  final offset = map["go"];
+  print(await dictReader.readOne(offset!.$1, offset.$2, offset.$3, offset.$4));
+}
+```
+
+## Read Data After Stored Data Offset
+
+```dart
+import 'package:dict_reader/dict_reader.dart';
+
+// ...
+
+void main() async {
+  // ...
+
+  final dictReader = DictReader("MDX FILE PATH");
+  // Pass false to reduce initialization time
+  await dictReader.init(false);
+
+  final offset = map["go"];
+  print(await dictReader.readOne(offset!.$1, offset.$2, offset.$3, offset.$4));
+}
+```
diff --git a/example/README_CN.md b/example/README_CN.md
@@ -0,0 +1,56 @@
+# 示例
+
+[English](./README.md) | 中文
+
+## 直接读取数据
+
+```dart
+import 'package:dict_reader/dict_reader.dart';
+
+void main() async {
+  final dictReader = DictReader("MDX FILE PATH");
+  await dictReader.init();
+
+  await for (final (keyText, data) in dictReader.read(true)) {
+    print("$keyText, $data");
+  }
+}
+```
+
+## 读取数据 offset，之后读取数据
+
+```dart
+import 'package:dict_reader/dict_reader.dart';
+
+void main() async {
+  final dictReader = DictReader("MDX FILE PATH");
+  await dictReader.init();
+
+  final map = <String, (int, int, int, int)>{};
+  await for (final (keyText, offset) in dictReader.read()) {
+    map[keyText] = offset;
+  }
+
+  final offset = map["go"];
+  print(await dictReader.readOne(offset!.$1, offset.$2, offset.$3, offset.$4));
+}
+```
+
+## 当已保存数据 offset，读取数据
+
+```dart
+import 'package:dict_reader/dict_reader.dart';
+
+// ...
+
+void main() async {
+  // ...
+
+  final dictReader = DictReader("MDX FILE PATH");
+  // Pass false to reduce initialization time
+  await dictReader.init(false);
+
+  final offset = map["go"];
+  print(await dictReader.readOne(offset!.$1, offset.$2, offset.$3, offset.$4));
+}
+```