From 167b9cf0293d64e3fe0c87a72d00b38c37c0d1b5 Mon Sep 17 00:00:00 2001 From: Joel Natividad <1980690+jqnatividad@users.noreply.github.com> Date: Sun, 12 Oct 2025 18:11:34 -0400 Subject: [PATCH] docs: add a note about endianness --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 8814ce1b..98f5fbd9 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,10 @@ fallback implementation, but this is significantly slower. For best performance, we highly suggest using [snmalloc](https://github.com/microsoft/snmalloc), [mimalloc](https://crates.io/crates/mimalloc) or [jemalloc](https://crates.io/crates/jemalloc) instead of the system default allocator. +### Endianness +This crate only works on little endian platforms. It DOES NOT WORK on big endian platforms (e.g. s390x, big-endian ARM, MIPS, etc.) +See https://doc.rust-lang.org/nightly/rustc/platform-support.html for a complete list. + ## Safety `simd-json` uses **a lot** of unsafe code.