Add a simple README

danakj · Jun 10, 2015 · f897487 · f897487
1 parent 15a28b9
commit f897487
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 0 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -13,6 +13,7 @@ script:
   - cargo test --no-default-features --features 'unix-backtrace'
   - cargo test --no-default-features --features 'unix-backtrace dladdr'
   - cargo test --no-default-features --features 'unix-backtrace libbacktrace'
+  - rustdoc --test README.md -L target/debug/deps -L target/debug
 notifications:
   email:
     on_success: never
diff --git a/README.md b/README.md
@@ -0,0 +1,41 @@
+# backtrace-rs
+
+A library for acquiring backtraces at runtime for Rust. This library aims to
+enhance the support given by the standard library at `std::rt` by providing a
+more stable and programmatic interface.
+
+## Install
+
+```toml
+[dependencies]
+backtrace = "0.1"
+```
+
+```rust
+extern crate backtrace;
+```
+
+## Usage
+
+```rust
+extern crate backtrace;
+
+fn main() {
+    backtrace::trace(&mut |frame| {
+        let ip = frame.ip();
+        let symbol_address = frame.symbol_address();
+
+        // Resolve this instruction pointer to a symbol name
+        backtrace::resolve(ip, &mut |symbol| {
+            if let Some(name) = symbol.name() {
+                // ...
+            }
+            if let Some(filename) = symbol.filename() {
+                // ...
+            }
+        });
+
+        true // keep going to the next frame
+    });
+}
+```