Skip to content

Commit 602610c

Browse files
committed
Update README
1 parent b02bb37 commit 602610c

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,15 @@
55
[Documentation](https://docs.rs/crate/hdf5)
66
[Changelog](https://github.com/aldanor/hdf5-rust/blob/master/CHANGELOG.md)
77

8-
The `hdf5` crate provides thread-safe Rust bindings and high-level wrappers for
9-
the HDF5 library API.
8+
The `hdf5` crate (previously known as `hdf5-rs`) provides thread-safe Rust bindings and
9+
high-level wrappers for the HDF5 library API. Some of the features include:
10+
11+
- Thread-safety with non-threadsafe libhdf5 builds guaranteed via reentrant mutexes.
12+
- Native representation of most HDF5 types, including variable-length strings and arrays.
13+
- Derive-macro for automatic mapping of user structs and enums to HDF5 types.
14+
- Multi-dimensional array reading/writing interface via `ndarray`.
15+
16+
Direct low-level bindings are also available and are provided in the `hdf5-sys` crate.
1017

1118
Requires HDF5 library of version 1.8.4 or later.
1219

0 commit comments

Comments
 (0)