diff --git a/README.md b/README.md index 6af2fd2..7b8aaff 100644 --- a/README.md +++ b/README.md @@ -10,24 +10,21 @@ - [Contact](#contact) - [Licenses](#licenses) +### [Documentation](https://redhawk989.github.io/EyeTrackVR/) + # EyeTrackVR Open source and *affordable* VR eye tracker platform for [VRChat](https://hello.vrchat.com/) via `OSC` and `UDP` protocol. -> **Important:** This project is in development and is not fully finished - +> **Note:** This project is in development and is not fully finished # Check out our documentation [here](https://redhawk989.github.io/EyeTrackVR/) - - ## Hardware 3d files for mounting brackets will be found [here](https://github.com/RedHawk989/EyeTrackVR-Hardware) IR emitter files are also located there. - - ## About IR Emitter Safety Please *exercise extreme caution* when messing around with IR emitters. @@ -36,7 +33,7 @@ Please *exercise extreme caution* when messing around with IR emitters. The safety measures were put in place to REDUCE the potential failure risk. All further safety responsibilities is on the user. This includes visually checking with an IR camera that the brightness is correct and making sure you do not feel warmth. -> **Important:** Make sure you are using **NON-focused** emitters and at around ***5ma total power***. +> **Warning:** Make sure you are using **NON-focused** emitters and at around ***5ma total power***. [Effect of infrared radiation on the lens](./docs/Reference_Docs/saftey/effect_of_ir_on_the_lens.pdf)