Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
heydocode authored Jun 29, 2024
1 parent 9af7961 commit ea1e43b
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# ServerAPI

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, creates an online server management panel, and provides a console managed by user input and ServerAPI.

## Features

- Easy installation and setup
- Sends machine statistics via email
- Online server management panel
- Console for server management
- Supports running a Minecraft server with monitoring

## Requirements

- Access to Wi-Fi
- A compatible device (iOS devices are not supported)

## Installation

1. Download and install the executable file.
2. Launch the software.
3. Follow the setup wizard.
4. Enjoy using ServerAPI!

## Usage

To launch ServerAPI with the Minecraft server option, use the following command:
```sh
serverapi launch mc_server
This command will install the necessary files and launch the Minecraft server in parallel with mail and setup threads to monitor the server files for any errors.

## Configuration
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.
## Support
For support, please create an "issue" on the GitHub page of the software.
Contributing
We welcome contributions! If you would like to contribute, please fork the repository and create a pull request. We are open to any suggestions for improvement.
## License
This project is open-source and available under the MIT license. You are free to use, modify, and distribute the code as needed.
## Acknowledgments
Special thanks to the Rust programming language community and the creators of the "lettre" Rust crate for making this project possible.

0 comments on commit ea1e43b

Please sign in to comment.