docs.

Lokathor · Sep 5, 2023 · c22cf36 · c22cf36
1 parent 01c2a07
commit c22cf36
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/derive/README.md b/derive/README.md
@@ -2,3 +2,9 @@
 # bytemuck_derive
 
 Derive macros for [bytemuck](https://docs.rs/bytemuck) traits.
+
+MSRV: None!
+
+This is an opt-in bonus feature for `bytemuck` that doesn't particularly do
+anything you couldn't do yourself, and so MSRV is not a strong consideration for
+this crate.
diff --git a/derive/changelog.md b/derive/changelog.md
@@ -12,8 +12,11 @@
 
 ## 1.4.0
 
-* ByteEq and ByteHash derives will make Eq and Hash impls that treat the value as a &[u8]. This provides a large codegen improvement for some types.
-* Derives of repr(int) enums should now accept byte literal values as the discriminant.
+* `ByteEq` and `ByteHash` derives will make `Eq` and `Hash` impls that treat the
+  value as a `&[u8]` during equality checks and hashing. This provides a large
+  codegen improvement for some types.
+* Derives of `repr(int)` enums should now accept byte literal values as the
+  discriminant.
 
 ## 1.3.0
 
@@ -31,7 +34,7 @@
   issuing this minor version bump in the `bytemuck_derive` crate. Because it's
   possible to *reduce* the minimum required version of a dep in only a patch
   release, I'm going to ratchet the required version of `syn` all the way up to
-  "curret" (1.0.99). If absolutely necessary we could probably reduce the
+  "current" (1.0.99). If absolutely necessary we could probably reduce the
   minimum `syn` version again in a patch release for 1.2, but I don't want to
   play this dance too much so I'd rather make each jump as big as can possibly
   be. [Issue 122](https://github.com/Lokathor/bytemuck/issues/122). **Note:**