Amend manifest

Author: JalonWong

Cargo.toml

@@ -2,12 +2,14 @@
     authors = ["Jalon Wong <[email protected]>"]
     categories = ["embedded", "hardware-support", "no-std"]
     description = "HAL for the STM32F1 family"
+    documentation = "https://docs.rs/stm32f1-hal"
     edition = "2024"
     keywords = ["arm", "cortex-m", "stm32", "hal"]
     license = "MIT OR Apache-2.0"
-    name = "jw-stm32f1-hal"
+    name = "stm32f1-hal"
     readme = "README.md"
-    version = "0.1.0"
+    repository = "https://github.com/jw-mcu-rust/stm32f1-hal"
+    version = "0.0.1"
 
 [features]
     critical-section-single-core = ["cortex-m/critical-section-single-core"]

README.md

@@ -1,4 +1,15 @@
-# jw-stm32f1-hal
+# stm32f1-hal
 Because the design of [stm32f1xx-hal](https://github.com/stm32-rs/stm32f1xx-hal) is unsuitable for my needs and [stm32-hal](https://github.com/David-OConnor/stm32-hal) doesn't support the F1 series, I decided to write a new crate.
 
 Many codes come from [stm32f1xx-hal](https://github.com/stm32-rs/stm32f1xx-hal).
+
+## Design
+Below are the design principles.
+1. Readability is the most important.
+    - We only write code a few times, but we read it countless times. Moreover, understanding the code is a necessary condition for maintaining it.
+2. Conciseness does not equal simplicity.
+    - Fewer lines of code mean conciseness, but being easy to understand is simplicity.
+
+Therefore, if a module is quite complex, I would not use a macro + generic approach, as it is too difficult to read.
+
+Instead, I use a script to generate code for GPIO alternate function remapping and a synchronization script to manage duplicate code across peripherals.