Merge pull request #2 from antiguru/productize

Author: antiguru

.github/workflows/test.yml

@@ -10,6 +10,7 @@ jobs:
         os:
           - ubuntu
           - macos
+          - windows
         toolchain:
           - stable
           - 1.72

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "numa_maps"
-version = "0.0.0"
+version = "0.1.0"
 edition = "2021"
 authors = ["Moritz Hoffmann <antiguru@gmail.com>"]
 description = "Parse the numa_maps file"

README.md

@@ -11,8 +11,23 @@ numa_maps = "0.1"
 ## Example
 
 ```rust
+#[cfg(target_os = "linux")]
+let map = numa_maps::NumaMap::from_file("/proc/self/numa_maps").unwrap();
+#[cfg(not(target_os = "linux"))]
+let map = numa_maps::NumaMap::default();
+
+for region in &map.ranges {
+    println!("base: {:x} -> {:?}", region.address, region.properties);
+}
+
 ```
 
+## Description
+
+`numa_maps` provides a simple API to read the contents of the `numa_maps` file.
+It parses the file into ranges with a base address, a policy, and a list of
+properties.
+
 #### License
 
 <sup>