README.md in ronin-fuzzer-0.1.0 vs README.md in ronin-fuzzer-0.2.0.rc1

- old
+ new

@@ -7,11 +7,10 @@ * [Website](https://ronin-rb.dev/) * [Source](https://github.com/ronin-rb/ronin-fuzzer) * [Issues](https://github.com/ronin-rb/ronin-fuzzer/issues) * [Documentation](https://ronin-rb.dev/docs/ronin-fuzzer/frames) * [Discord](https://discord.gg/6WAb3PsVX9) | - [Twitter](https://twitter.com/ronin_rb) | [Mastodon](https://infosec.exchange/@ronin_rb) ## Description ronin-fuzzer is a Ruby library and CLI for generating, mutating, and fuzzing @@ -31,16 +30,30 @@ ```shell $ ronin-fuzzer fuzz -i http_request.txt -o bad.txt -r unix_path:bad_strings ``` +## Examples + +Replace every `e`, `i`, `o`, `u` with `(`, 100 `A`s and a `\0`: + +```ruby +require 'ronin/fuzzing' + +"the quick brown fox".fuzz(/[eiou]/ => ['(', ('A' * 100), "\0"]) do |str| + p str +end +``` + +For more examples, please see the [API documentation](https://ronin-rb.dev/docs/ronin-fuzzer/String.html). + ## Requirements * [Ruby] >= 3.0.0 * [combinatorics] ~> 0.4 * [ronin-support] ~> 1.0 -* [ronin-core] ~> 0.1 +* [ronin-core] ~> 0.2 ## Install ```shell $ gem install ronin-fuzzer @@ -61,18 +74,18 @@ ## Development 1. [Fork It!](https://github.com/ronin-rb/ronin-fuzzer/fork) 2. Clone It! 3. `cd ronin-fuzzer/` -4. `bundle install` +4. `./scripts/setup` 5. `git checkout -b my_feature` 6. Code It! 7. `bundle exec rake spec` 8. `git push origin my_feature` ## License -Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3@gmail.com) +Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3@gmail.com) This file is part of ronin-fuzzer. ronin-fuzzer is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published