Medzik
/
servers
mirror of https://github.com/MedzikUser/servers
1
0
Fork 0
Code Issues 1 Projects Releases Wiki Activity

doc: add readme

This commit is contained in:
MedzikUser 2022-06-16 20:22:30 +02:00
parent 533769abbc
commit a4c355f789
No known key found for this signature in database
GPG Key ID: A5FAC1E185C112DB
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md Normal file
View File

@ -0,0 +1,24 @@
# Servers - Simple TCP server
[docs-rs]: https://img.shields.io/badge/docs.rs-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs
[total-lines]: https://img.shields.io/tokei/lines/github/MedzikUser/servers?style=for-the-badge&logo=github&color=fede00
[code-size]: https://img.shields.io/github/languages/code-size/MedzikUser/servers?style=for-the-badge&color=c8df52&logo=github
[ci]: https://img.shields.io/github/workflow/status/MedzikUser/servers/Rust/main?style=for-the-badge
[![docs-rs]](https://servers.medzik.xyz)
[![total-lines]](https://github.com/MedzikUser/servers)
[![code-size]](https://github.com/MedzikUser/servers)
[![ci]](https://github.com/MedzikUser/servers/actions/workflows/build.yml)
A simple TCP server for client written in Rust 🦀 which can be extended with plugins.
## 👨‍💻 Building
First clone the repository: `git clone https://github.com/MedzikUser/servers.git`
### Requirements
- Rust
To build run the command: `cargo build --release`
The compiled binary can be found in `./target/release/servers`