[Crate] Add warning about frequent API breaking changes in the Readme

This commit is contained in:
CosminPerRam 2023-03-03 17:54:13 +02:00
parent 950c08c18e
commit f97de3bb63

View file

@ -1,5 +1,7 @@
# rust-GameDig [![CI](https://github.com/cosminperram/rust-gamedig/actions/workflows/ci.yml/badge.svg)](https://github.com/CosminPerRam/rust-gamedig/actions) [![Latest Version](https://img.shields.io/crates/v/gamedig.svg?color=yellow)](https://crates.io/crates/gamedig) [![Crates.io](https://img.shields.io/crates/d/gamedig?color=purple)](https://crates.io/crates/gamedig) [![License:MIT](https://img.shields.io/github/license/cosminperram/rust-gamedig?color=blue)](LICENSE.md)
**Warning**: This project goes through frequent API breaking changes and hasn't been thoroughly tested.
**rust-GameDig** is a games/services server query library that can fetch the availability and/or details of those, this library brings what **[node-GameDig](https://github.com/gamedig/node-gamedig)** does, to pure Rust!
Minimum Supported Rust Version is `1.56.1` and the code is cross-platform.