Skip to content

Commit

Permalink
πŸ“œ docs: Adding recommendations of other projects to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
henriquesebastiao authored Dec 2, 2024
1 parent f1e9490 commit 68023c6
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

[![CI](https://github.com/henriquesebastiao/saturn/actions/workflows/ci.yml/badge.svg)](https://github.com/henriquesebastiao/saturn/actions/workflows/ci.yml)
[![Build](https://github.com/henriquesebastiao/saturn/actions/workflows/build.yml/badge.svg)](https://github.com/henriquesebastiao/saturn/actions/workflows/build.yml)
[![Version](https://img.shields.io/badge/Arduino-00878F?style=flat&logo=arduino&logoColor=white)](https://github.com/henriquesebastiao/saturn/)
[![Version](https://img.shields.io/badge/version-1.2.1-blue)](https://github.com/henriquesebastiao/saturn/tags)
[![License](https://img.shields.io/github/license/henriquesebastiao/saturn)](https://github.com/henriquesebastiao/saturn/blob/main/LICENSE)

Expand Down Expand Up @@ -33,9 +34,17 @@ Other sources were also borrowed:
- https://github.com/hibit-dev/buzzer/tree/master
- https://github.com/henriquesebastiao/RouterBOARD-Scripts

### Other recommended projects

If you liked this project, I recommend you check out the others listed below, you will probably find a lot of value in them too. Developed by the Brazilian community πŸ‡§πŸ‡·.

- [Bruce](https://github.com/pr3y/Bruce) - A firmware with several offensive features for red team activities.
- [Launcher](https://github.com/bmorcelli/M5Stick-Launcher) - A firmware to flash other binaries to your device in a standalone manner.

### An advance warning

This project is still in its initial phase and is being developed for my own learning, therefore, it may not generate the expected result at some point. The code is still under development and may contain bugs and flaws. If you find something that doesn't seem to be working correctly, don't hesitate to open an issue reporting the error you experienced. I will do my best to help you.
> [!WARNING]
> This project is still in its initial phase and is being developed for my own learning, therefore, it may not generate the expected result at some point. The code is still under development and may contain bugs and flaws. If you find something that doesn't seem to be working correctly, don't hesitate to open an issue reporting the error you experienced. I will do my best to help you.
## Features

Expand All @@ -47,6 +56,7 @@ Implementation of the main remote control buttons for some types of devices.

- TVs (Samsung, Philips, Toshiba)

> [!NOTE]
> Currently, tests have only been carried out on a Samsung TV. Contributions are welcome to add support for new manufacturers and devices.
#### Buttons implemented
Expand Down Expand Up @@ -238,4 +248,5 @@ This project is licensed under the GPL-3.0 License - see the [LICENSE](LICENSE)

## Disclaimer

The functionalities present in this firmware are for educational purposes only, being tested only in controlled and isolated environments. The maintainers are not responsible for any misuse of this tool.
> [!IMPORTANT]
> The functionalities present in this firmware are for educational purposes only, being tested only in controlled and isolated environments. The maintainers are not responsible for any misuse of this tool.

0 comments on commit 68023c6

Please sign in to comment.