From 201c2a45e8916433458767fb8b24f268c8275e7e Mon Sep 17 00:00:00 2001 From: Samuel Pua Date: Sat, 7 Apr 2018 00:28:23 +0800 Subject: [PATCH] Update README.md --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 84986e2..83ef228 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,26 @@ # fuzzPattern -Creates fuzz pattern for fuzzing purpose +Creates fuzz pattern for fuzzing purpose. Use fuzzPatternCreate to create pattern and fuzzPatternSearch to find the string/hex found. + +The item found is assumed to be 4 bytes (32 bit) or above. + +Coded in Golang. + +## Getting Started + +The executables are statically built (thanks to Golang) on a 64 bit Linux machine. If there's a need to rebuild from source, you may use the sources included as well. + +Dependencies: +> gopkg.in/alecthomas/kingpin.v2 + +## Deployment + +Recommended to deploy as part of easyscripts deployment (https://github.com/telboon/easyscripts) + +## Authors + +* **Samuel Pua** - *Initial work* - (https://github.com/telboon) + +## License + +This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details +