Skip to content
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

<div align="center">

[![Keil & HEX checks](https://github.com/FuTseYi/PulseBand/actions/workflows/keil-path-check.yml/badge.svg)](https://github.com/FuTseYi/PulseBand/actions/workflows/keil-path-check.yml)
![Version](https://img.shields.io/badge/version-1.0.0-blue.svg)
![License](https://img.shields.io/badge/license-MIT-green.svg)
![Platform](https://img.shields.io/badge/platform-STM32F103-red.svg)
Expand All @@ -19,7 +20,7 @@
</div>

---
![Star History Chart](https://api.star-history.com/svg?repos=FuTseYi/STM32-Health-Band&type=Date)
![Star History Chart](https://api.star-history.com/svg?repos=FuTseYi/PulseBand&type=Date)

## 📖 Project Overview

Expand Down Expand Up @@ -78,8 +79,8 @@ For detailed hardware list and connection instructions, please refer to [hardwar

1. **Clone the Project**
```bash
git clone https://github.com/FuTseYi/STM32-Health-Band.git
cd STM32-Health-Band
git clone https://github.com/FuTseYi/PulseBand.git
cd PulseBand
```

2. **Open Project**
Expand Down Expand Up @@ -219,6 +220,8 @@ For detailed contribution guidelines, see [contribution guidelines](docs/CONTRIB
- Macro definition: uppercase + underscore `MAX_BUFFER_SIZE`
- Comments: Use Doxygen style comments

For vulnerability reporting and hardware-use limitations, see [SECURITY.md](SECURITY.md).

## 📄 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Expand Down Expand Up @@ -246,8 +249,8 @@ Thanks to the following open source projects and resources:

## 📞 Contact

- 📧 **Issues**: [Submit Issue](https://github.com/FuTseYi/STM32-Health-Band/issues)
- 💬 **Discussions**: [Join Discussion](https://github.com/FuTseYi/STM32-Health-Band/discussions)
- 📧 **Issues**: [Submit Issue](https://github.com/FuTseYi/PulseBand/issues)
- 💬 **Discussions**: [Join Discussion](https://github.com/FuTseYi/PulseBand/discussions)

## 📊 Changelog

Expand Down
15 changes: 9 additions & 6 deletions README_zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

<div align="center">

[![Keil & HEX checks](https://github.com/FuTseYi/PulseBand/actions/workflows/keil-path-check.yml/badge.svg)](https://github.com/FuTseYi/PulseBand/actions/workflows/keil-path-check.yml)
![Version](https://img.shields.io/badge/version-1.0.0-blue.svg)
![License](https://img.shields.io/badge/license-MIT-green.svg)
![Platform](https://img.shields.io/badge/platform-STM32F103-red.svg)
Expand All @@ -18,7 +19,7 @@

---

![Star History Chart](https://api.star-history.com/svg?repos=FuTseYi/STM32-Health-Band&type=Date)
![Star History Chart](https://api.star-history.com/svg?repos=FuTseYi/PulseBand&type=Date)

## 📖 项目简介

Expand Down Expand Up @@ -77,8 +78,8 @@

1. **克隆项目**
```bash
git clone https://github.com/FuTseYi/STM32-Health-Band.git
cd STM32-Health-Band
git clone https://github.com/FuTseYi/PulseBand.git
cd PulseBand
```

2. **打开工程**
Expand Down Expand Up @@ -143,7 +144,7 @@
## 📂 项目结构

```
STM32-Health-Band/
PulseBand/
├── firmware/ # 固件源代码
│ ├── CORE/ # STM32 核心文件
│ ├── FWLIB/ # STM32 固件库
Expand Down Expand Up @@ -233,6 +234,8 @@ Total_G = √(X² + Y² + Z²)
- 宏定义:大写字母+下划线 `MAX_BUFFER_SIZE`
- 注释:使用 Doxygen 风格注释

有关漏洞反馈、固件使用与硬件安全限制,请阅读 [安全说明](SECURITY.md)。

## 📄 许可证

本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情。
Expand Down Expand Up @@ -260,8 +263,8 @@ Total_G = √(X² + Y² + Z²)

## 📞 联系方式

- 📧 **Issues**: [提交 Issue](https://github.com/FuTseYi/STM32-Health-Band/issues)
- 💬 **Discussions**: [参与讨论](https://github.com/FuTseYi/STM32-Health-Band/discussions)
- 📧 **Issues**: [提交 Issue](https://github.com/FuTseYi/PulseBand/issues)
- 💬 **Discussions**: [参与讨论](https://github.com/FuTseYi/PulseBand/discussions)

## 📊 更新日志

Expand Down
16 changes: 16 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Security and hardware safety

PulseBand is an **educational STM32 wearable prototype**, not a medical device. Its firmware, mobile application, sensor readings, wireless transport and historical HEX snapshot have not undergone a formal security, clinical or electrical safety assessment.

## Important limitations

- Do not rely on heart-rate, SpO2, temperature, fall-detection or other readings for diagnosis or emergency response.
- Verify power connections and board revision before flashing or connecting battery-powered hardware.
- The [firmware verification guide](docs/FIRMWARE-VERIFICATION.md) describes basic integrity checks; these do not prove fitness for a particular board or safety-critical usage.
- Review any Wi-Fi credentials, companion-app network traffic, firmware update paths and third-party licenses before practical deployment.

## Reporting issues

Use GitHub private vulnerability reporting if enabled, or contact the maintainer privately through the GitHub profile contact method. Do not disclose secrets or exploitable details in a public issue. General bugs and documentation defects may be reported through [Issues](https://github.com/FuTseYi/PulseBand/issues).

No formal vulnerability-response SLA or medical safety certification is claimed.
4 changes: 2 additions & 2 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

<div align="center">

**欢迎为 STM32-Health-Band 项目做出贡献!**
**欢迎为 PulseBand 项目做出贡献!**

[报告问题](#-报告问题-bug-reports) • [功能请求](#-功能请求-feature-requests) • [代码贡献](#-代码贡献) • [文档贡献](#-文档贡献) • [社区准则](#社区准则)

</div>

---

感谢您对 STM32-Health-Band 项目的关注!我们欢迎任何形式的贡献,包括但不限于代码改进、文档完善、问题反馈和功能建议。
感谢您对 PulseBand 项目的关注!我们欢迎任何形式的贡献,包括但不限于代码改进、文档完善、问题反馈和功能建议。

## 如何贡献

Expand Down
2 changes: 1 addition & 1 deletion docs/DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# STM32-Health-Band 开发文档
# PulseBand 开发文档

<div align="center">

Expand Down
2 changes: 1 addition & 1 deletion docs/HARDWARE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# STM32-Health-Band 硬件说明文档
# PulseBand 硬件说明文档

<div align="center">

Expand Down
Loading