Merge branch 'test' into 'main'

chore: add CHANGELOG.md to document important changes and versioning

See merge request jerome/ssrkit!3

CHANGELOG.md

@@ -0,0 +1,36 @@
+# Changelog
+
+所有對 ssrkit 的重要更改都將記錄在此文件中。
+
+格式基於 [Keep a Changelog](https://keepachangelog.com/zh-TW/1.0.0/)，
+並且本項目遵循 [Semantic Versioning](https://semver.org/lang/zh-TW/)。
+
+## [Unreleased]
+
+### 新增
+- 計劃中的新功能
+
+### 變更
+- 計劃中的變更
+
+### 修復
+- 計劃修復的問題
+
+## [0.1.0] - 2023-08-01
+
+### 新增
+- 初始版本發布
+- 參數處理系統
+- Island 架構支持
+- 內置模板系統
+- 全局狀態管理
+- 與 ssr-rs 的集成
+
+### 變更
+- 無
+
+### 修復
+- 無
+
+[Unreleased]: https://github.com/jeromeleong/ssrkit/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/jeromeleong/ssrkit/releases/tag/vc

Cargo.toml

@@ -10,4 +10,4 @@ chrono = "0.4"
 regex = "1.10.5"
 nanoid = "0.4.0"
 indoc = "2.0.5"
-lru = "0.12.3"
+lru = "0.12.4"

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Jerome Leong <jeromeleong1998@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -19,7 +19,7 @@
 
 ```toml
 [dependencies]
-ssrkit = { git = "https://git.leongfamily.net/jerome/ssrkit.git" }
+ssrkit = { git = "https://github.com/jeromeleong/ssrkit.git" }
 ssr = "0.5.7" # 確保使用與 ssrkit 相容的 ssr 版本
 ```
 
@@ -62,8 +62,8 @@ impl IslandProcessor for ExampleIslandProcessor {
                     .render_island(
                         "Counter",
                         &json!({
-                                           "initialCount": 0,
-                                           "client": "load"
+                            "initialCount": 0,
+                            "client": "load"
                         }),
                     )
                     .unwrap_or_default()
@@ -94,9 +94,9 @@ fn main() {
                 let instance_id = props["instanceId"].as_str().unwrap_or("");
                 Ok(format!(
                     r#"<div id="{}" data-island="Counter" data-props='{}'>
- <button>遞增</button>
- <span>{}</span>
- </div>"#,
+                        <button>遞增</button>
+                        <span>{}</span>
+                    </div>"#,
                     instance_id,
                     serde_json::to_string(props).unwrap(),
                     initial_count
@@ -133,8 +133,8 @@ fn main() {
         Ok(json!({
         "html": format!(
         r#"<h1>{}</h1>
- <div data-island="Counter" data-name="counter" data-props='{{"initialCount": 0}}'></div>
- {}"#,
+            <div data-island="Counter" data-name="counter" data-props='{{"initialCount": 0}}'></div>
+        {}"#,
         content,
         rendered
         ),
@@ -497,11 +497,11 @@ ssrkit 基於 ssr-rs 項目，並對其進行了擴展。以下是 ssrkit 與 ss
 
 ## 許可
 
-ssrkit 暫無許可證。
+ssrkit 使用 MIT 許可證。
 
 ## 致謝
 
-特別感謝 ssr-rs 專案的開發者，他們的工作為 ssrkit 奠定了基礎。同時也感謝所有為 ssrkit 做出貢獻的開發者。
+特別感謝 ssr-rs 專案的開發者，他的工作為 ssrkit 奠定了基礎。
 
 ## 相關項目
 
@@ -517,7 +517,7 @@ ssrkit 暫無許可證。
 
 如果你有任何問題或建議，可以透過以下方式聯絡我：
 
-- GitHub Issues: [ssrkit issues](https://git.leongfamily.net/jerome/ssrkit/-/issues)
+- GitHub Issues: [ssrkit issues](https://github.com/jeromeleong/ssrkit/issues)
 - Email: jeromeleong1998@gmail.com
 
 感謝你使用 ssrkit！我們期待看到你用它構建的出色應用。