diff --git a/Cargo.toml b/Cargo.toml index e065d0d..9674ae4 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,8 +1,8 @@ [package] name = "linkmap" -version = "0.1.0" +version = "0.1.1" edition = "2021" -description = "🦀️linkmap file parser" +description = "🦀️Linkmap file parse library" license = "MIT" repository = "https://github.com/everettjf/linkmap-rs" diff --git a/README.md b/README.md index 15792ba..86d3877 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,31 @@ # linkmap-rs -Linkmap file parser for rust. +Linkmap file parse library for rust. Usage : > ref examples/main.rs +```rust + let linkmap = linkmap::parse_linkmap(&path, true)?; + + println!("path : {}", linkmap.path); + println!("arch : {}", linkmap.arch); + println!("object files:"); + for file in &linkmap.object_files { + println!("{:?}", file); + } + println!("sections:"); + for section in &linkmap.sections { + println!("{:?}", section); + } + println!("symbols:"); + for symbol in &linkmap.symbols { + println!("{:?}", symbol); + } + println!("dead_stripped_symbols:"); + for symbol in &linkmap.dead_stripped_symbols { + println!("{:?}", symbol); + } +``` \ No newline at end of file