From c8950d44ecf15eb55265f86dcd68c9579151f99c Mon Sep 17 00:00:00 2001 From: Gorkem Date: Mon, 28 Jul 2025 15:37:11 -0500 Subject: [PATCH] Update README.md --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index e69de29..d1ef4fa 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,12 @@ +# Eye Guardian + +[![License: GNU General Public License v3.0](https://img.shields.io/badge/Firmware%20License-GNU%20GPL--v3.0-yellow)](https://www.gnu.org/licenses/gpl-3.0.en.html#license-text) +[![License: CC BY-SA 4.0](https://img.shields.io/badge/Documentation%20License-CC_BY--SA_4.0-lightgrey)](https://creativecommons.org/licenses/by-sa/4.0/) + + +This repository contains all the files and documentation for Eye Guardian, an Arduino powered, High-Decibel continuous sound triggered eye protection wear. [Visit the DIY guide](https://gorkem.cc/projects/EyeGuardian) for details. + + +File structure: ++ `Firmware` contains the code and necessary drivers. ++ `CAD` contains print ready .stl files \ No newline at end of file