diff --git a/.gitignore b/.gitignore index d175af0..0537f4b 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ server_config.toml test_speedtest.db -tasks.md +assets .idea -target \ No newline at end of file +target +build_script \ No newline at end of file diff --git a/README.md b/README.md index 6d5d7a6..e649500 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,49 @@ ![LibreSpeed Logo](https://github.com/librespeed/speedtest/blob/master/.logo/logo3.png?raw=true) -# speedtest-rust +# speedtest-rust (WIP) -### Project under development. Be patient until release 😊 \ No newline at end of file +No Flash, No Java, No WebSocket, No Bullshit. + +## Compatibility +All modern browsers are supported: IE11, latest Edge, latest Chrome, latest Firefox, latest Safari. +Works with mobile versions too. + +## Attributes +- Memory safety +- Lightweight & Low overhead +- Low level networking +- Based on tokio-rs (asynchronous) + +## Features +- Download +- Upload +- Ping +- Jitter +- IP Address, ISP, distance from server (optional, not implemented currently) +- Telemetry (optional) +- Results sharing (optional) + +## Server requirements +- Any [Rust supported platforms](https://doc.rust-lang.org/beta/rustc/platform-support.html) +- PostgreSQL or MySQL database to store test results (optional) +- A fast! Internet connection + +## Installation +- WIP ... + +## License +Copyright (C) 2016-2024 Federico Dossena\ +Copyright (C) 2024 Sudo Dios + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU Lesser General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU Lesser General Public License +along with this program. If not, see . \ No newline at end of file