Skip to content

Commit c2d5bac

Browse files
committed
Update README to clarify default vs optional features
- Reorganize Features section to show default features separately - Document that ffi is now in default features (backward compatibility) - Note that ffi will become optional in v2.0
1 parent 583f758 commit c2d5bac

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,15 @@ DESTDIR=/my/custom/path make install
5353

5454
The library supports various feature flags for different environments:
5555

56-
* `std` (default) - Standard library support, includes `alloc`
56+
### Default Features
57+
* `std` - Standard library support, includes `alloc`
58+
* `ffi` - C/C++ FFI bindings for shared library (will become optional in v2.0)
59+
* `panic-handler` - Provides panic handler for `no_std` environments (disable when building binaries)
60+
61+
### Optional Features
5762
* `alloc` - Heap allocation support (enables `Digest` trait, custom CRC params, checksum combining)
5863
* `cache` - Caches generated constants for custom CRC parameters (requires `alloc`)
5964
* `cli` - Enables command-line tools (`checksum`, `arch-check`, `get-custom-params`)
60-
* `ffi` - C/C++ FFI bindings for shared library
61-
* `panic-handler` - Provides panic handler for `no_std` environments (disable when building binaries)
6265

6366
### Building for no_std
6467

0 commit comments

Comments
 (0)