diff --git a/README.md b/README.md index 1f85586..e154d25 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# simapi_serialization +# serialization(simcu::serialization) SimApi 全反射 JSON 序列化库(仓颉版),对齐 .NET `System.Text.Json` 的用法与注解风格。 @@ -12,13 +12,26 @@ SimApi 全反射 JSON 序列化库(仓颉版),对齐 .NET `System.Text.Jso ### 引入 +两种方式任选其一: + +**方式一:中央仓**(需先 `cjpm publish` 发布 `simcu::serialization`) + ```toml [dependencies] -simapi_serialization = { path = "../simapi-serialization" } +"simcu::serialization" = "1.0.3" ``` +**方式二:Git 仓库** + +```toml +[dependencies] +"simcu::serialization" = { git = "https://gitcode.com/simcu/serialization-cj.git", version = "1.0.3" } +``` + +> 本地开发也可用 path 依赖:`"simcu::serialization" = { path = "../simapi-serialization" }` + ```cangjie -import simapi_serialization.* // 一个 import 全量可用(注解 + 序列化器) +import simcu::serialization.* // 一个 import 全量可用(注解 + 序列化器) ``` ### 序列化 / 反序列化 @@ -70,8 +83,8 @@ Cangjie 反射对实例成员读写有**声明类严格校验**(`declaringClas ### 用法 ```cangjie -import simapi_serialization.* -import simapi_serialization.macros.* +import simcu::serialization.* +import simcu::serialization.macros.* @SerializerParent // 标注在父类上;非 open 类自动补 open class BaseUser {