diff --git a/README.md b/README.md index ac9e508..f5bc606 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,28 @@ # go-bindiff -Go package to interface with bindiff +[![Go](https://github.com/blacktop/go-bindiff/actions/workflows/go.yml/badge.svg)](https://github.com/blacktop/go-bindiff/actions/workflows/go.yml) [![Go Reference](https://pkg.go.dev/badge/github.com/blacktop/go-bindiff.svg)](https://pkg.go.dev/github.com/blacktop/go-bindiff) [![License](http://img.shields.io/:license-mit-blue.svg)](http://doge.mit-license.org) + +> Go package to interface with bindiff + +## Getting Started + +``` +go get github.com/blacktop/go-bindiff +``` + +### `bindiff` demo tool + +Install + +``` +go install github.com/blacktop/go-bindiff/cmd/bindiff@latest +``` + +Usage + +``` +bindiff path/to/BinExport1 path/to/BinExport2 +``` + +## License + +MIT Copyright (c) 2025 **blacktop** \ No newline at end of file