tribufu/rust-gamedig
1
0
Fork 0
mirror of https://github.com/tribufu/rust-gamedig synced 2026-05-06 07:17:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Bumped version and modified README

Browse source
This commit is contained in:
CosminPerRam 2022-10-20 13:09:11 +03:00
parent 3c6cbda0f5
commit 21d2bc45a1
3 changed files with 18 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

18
CHANGELOG.md
View file

@ -1,11 +1,17 @@
Who knows what the future holds...
# 0.0.1 - 16/09/2022
The first usable version of the crate, yay!
It brings:
- Initial implementation of the [valve server query protocol](https://developer.valvesoftware.com/wiki/Server_queries).
- Initial [Team Fortress 2](https://en.wikipedia.org/wiki/Team_Fortress_2) support.
# 0.0.2 - 20/10/2022
Further implementation of the Valve protocol (PLAYERS and RULES queries).
[Counter Strike: Global Offensive](https://store.steampowered.com/app/730/CounterStrike_Global_Offensive/) implementation.
[The Ship](https://developer.valvesoftware.com/wiki/The_Ship) implementation.
The library now has error handling.
# 0.0.0 - 15/09/2022
# 0.0.1 - 16/10/2022
The first usable version of the crate, yay!
It brings:
Initial implementation of the [Valve server query protocol](https://developer.valvesoftware.com/wiki/Server_queries).
Initial [Team Fortress 2](https://en.wikipedia.org/wiki/Team_Fortress_2) support.
# 0.0.0 - 15/10/2022
The first *markdown*, the crate is unusable as it doesn't contain anything helpful.

2
Cargo.toml
View file

@ -1,6 +1,6 @@
[package]
name = "gamedig"
version = "0.0.1"
version = "0.0.2"
edition = "2021"
authors = ["CosminPerRam [cosmin.p@live.com]", "node-GameDig [https://github.com/gamedig/node-gamedig]"]
license = "MIT"

10
README.md
View file

@ -3,8 +3,8 @@ rust-GameDig is a game server/services query library, capable of querying the st
MSRV is `1.58.1` and the code is cross-platform.
# Example
Basic usage of the library is:
## Usage
Just pick a game, provide the ip and the port (can be optional) then query on it.
```rust
use gamedig::games::tf2;
@ -18,12 +18,12 @@ fn main() {
```
To see more examples, see the [examples](examples) folder.
# Documentation
## Documentation
The documentation is available at [docs.rs](https://docs.rs/gamedig/latest/gamedig/).
Curious about the history and what changed between versions? you can see just that in the [CHANGELOG](CHANGELOG.md) file.
# Games List
## Games List
To see the supported (or the planned to support) games, see [GAMES](GAMES.md).
# Contributing
## Contributing
If you want see your favorite game/service being supported here, open an issue and I'll prioritize it! (or do a pull request if you want to implement it yourself)