From b2911892448b295c9d19b9ac0ae09eaf6e74a80a Mon Sep 17 00:00:00 2001 From: Jerome Date: Thu, 1 Aug 2024 18:47:19 +0800 Subject: [PATCH] feat(Cargo.toml): add metadata fields including authors, description, repository, license, keywords, and categories to provide better project information docs(README.md): add badges for version, clippy analysis, and license to enhance project visibility and status representation fix(README.md): update ssrkit dependency to use version 0.1.0 for proper versioning and compatibility --- Cargo.toml | 6 ++++++ README.md | 8 ++++++-- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 5a440df..4960627 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -2,6 +2,12 @@ name = "ssrkit" version = "0.1.0" edition = "2021" +authors = ["Jerome Leong "] +description = "SSR simplifier in Rust" +repository = "https://github.com/jeromeleong/SsrKit" +license = "MIT" +keywords = ["ssr", "web"] +categories = ["web-programming"] [dependencies] serde = { version = "1.0", features = ["derive"] } diff --git a/README.md b/README.md index 68b3578..d91f291 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ # ssrkit +![Crates.io](https://img.shields.io/crates/v/ssrkit) +[![rust-clippy analyze](https://github.com/jeromeleong/SsrKit/actions/workflows/rust-clippy.yml/badge.svg)](https://github.com/jeromeleong/SsrKit/actions/workflows/rust-clippy.yml) +![License](https://img.shields.io/crates/l/ssrkit) + `ssrkit` 是一個強大且靈活的 Rust 函式庫,專為簡化伺服器端渲染(SSR)的實作流程而設計。它基於 [ssr-rs](https://github.com/Valerioageno/ssr-rs) 項目,進一步擴展了功能和易用性。 ssrkit 提供了一套完整的工具,包括參數處理系統、Island 架構支援和模板渲染功能,可無縫整合到各種 Web 框架中。 ## 特性 @@ -19,8 +23,8 @@ ```toml [dependencies] -ssrkit = { git = "https://github.com/jeromeleong/ssrkit.git" } -ssr = "0.5.7" # 確保使用與 ssrkit 相容的 ssr 版本 +ssrkit = "0.1.0" +ssr = "0.5.7" # 確保使用與 ssrkit 相容的 ssr-rs 或其他 ssr 庫 ``` 注意:ssrkit 依賴 ssr-rs 和其他 SSR 相關函式庫。請確保你的專案中包含了所有必要的依賴。