Skip to content

Commit 0c12d51

Browse files
committed
docs(readme): badge row and the widened debug feature
Adds crates.io version and downloads, docs.rs, MSRV and stars to the badge row, alongside the CI, license, Scorecard and dependency badges already there. The debug feature description no longer says 'parser': it now also covers the opcode helpers and call-stack walking added in this release.
1 parent 9524c09 commit 0c12d51

2 files changed

Lines changed: 11 additions & 2 deletions

File tree

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,8 @@ piece was already running against live SA-MP and open.mp servers.
5858
call stack.
5959
- [API reference](docs/api-reference.md) updated with the new `Amx` methods and
6060
the widened `samp::debug` surface.
61+
- README: the `debug` feature is no longer described as only a parser, and the
62+
badge row gains crates.io version and downloads, docs.rs, MSRV and stars.
6163

6264
### Crate versions
6365

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
[![CI](https://github.com/NullSablex/rust-samp/actions/workflows/rust.yml/badge.svg)](https://github.com/NullSablex/rust-samp/actions/workflows/rust.yml)
2+
[![crates.io](https://img.shields.io/crates/v/rust-samp?logo=rust)](https://crates.io/crates/rust-samp)
3+
[![downloads](https://img.shields.io/crates/d/rust-samp?logo=rust&label=downloads)](https://crates.io/crates/rust-samp)
4+
[![docs.rs](https://img.shields.io/docsrs/rust-samp?logo=docsdotrs&label=docs.rs)](https://docs.rs/rust-samp)
5+
[![MSRV](https://img.shields.io/crates/msrv/rust-samp?label=MSRV)](Cargo.toml)
6+
[![stars](https://img.shields.io/github/stars/NullSablex/rust-samp?logo=github)](https://github.com/NullSablex/rust-samp/stargazers)
27
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
38
[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/NullSablex/rust-samp/badge)](https://scorecard.dev/viewer/?uri=github.com/NullSablex/rust-samp)
49
[![dependency status](https://deps.rs/repo/github/NullSablex/rust-samp/status.svg)](https://deps.rs/repo/github/NullSablex/rust-samp)
@@ -103,8 +108,10 @@ are 32-bit.
103108
loads on Open Multiplayer in legacy mode.
104109
- `encoding` — Windows-1251 / Windows-1252 string conversion via
105110
`encoding_rs`.
106-
- `debug` — the `samp::debug` AMX_DBG debug-info parser, for building
107-
debuggers/tooling on the VM (see [VM Debugging](docs/vm-debugging.md)).
111+
- `debug``samp::debug`: the AMX_DBG debug-info parser plus the opcode
112+
helpers (numbering, instruction sizes, the computed-goto `OpcodeMap`) and
113+
call-stack walking, for building debuggers and tooling on the VM (see
114+
[VM Debugging](docs/vm-debugging.md)).
108115
- `compression` — gzip-compress rotated log archives
109116
(`LoggerConfig::compress_archives`); pulls in `flate2`.
110117

0 commit comments

Comments
 (0)