Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
heydocode authored Nov 10, 2024
1 parent 9272f8f commit 66d1437
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

ServerAPI is a versatile software that allows you to turn any machine (Windows, Linux, and macOS) into a server. It sends machine statistics via email (configurable via setup wizard), display and register logs.

## Technologies

This project uses [`lettre`](https://lettre.rs/) crate to send e-mails, async-std to execute code in async/await and [`valence`](https://valence.rs/) to add minecraft server software that runs in async with the mail server (removed). Everything is written in the **Rust** programming language (except the sent mail which is written in html & css, see the [`showcase`](https://github.com/heydocode/ServerAPI/tree/master/README.md#Showcase) section).

## IMPORTANT
ServerAPI is in "active" (now is not) developpement and is not released yet!

Expand Down Expand Up @@ -40,6 +44,10 @@ ServerAPI is in "active" (now is not) developpement and is not released yet!

ServerAPI includes a setup wizard that guides the user through the necessary configuration steps. The user simply needs to answer the wizard's questions and confirm the provided information.

## Showcase

![image](screenshots/ServerAPIemail.png)

## Support

For support, please create an "issue" on the GitHub page of the software.
Expand Down

0 comments on commit 66d1437

Please sign in to comment.