From 151a593191abe9b8bbf1f90130f968ff932de6e4 Mon Sep 17 00:00:00 2001 From: Tyson Smith Date: Wed, 20 Dec 2023 10:01:03 -0800 Subject: [PATCH] Update README.md --- README.md | 34 ++++++++++++++++++++++++++++------ 1 file changed, 28 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 41216ca2..0545cf73 100644 --- a/README.md +++ b/README.md @@ -13,19 +13,41 @@ However not all features may be available. For additional information please check out the [wiki](https://github.com/MozillaSecurity/grizzly/wiki) or the [announcement](https://blog.mozilla.org/security/2019/07/10/grizzly/). Quick Start ------------- +----------- Install the latest version from PyPI. For more details see [getting started](https://github.com/MozillaSecurity/grizzly/wiki/Getting-Started) on the wiki. -```python3 -m pip install grizzly-framework``` +``` +python3 -m pip install grizzly-framework --upgrade +``` -**Fuzz** - Run the `no-op` test adapter to check everything is working. +**Fuzzing** - Run the `no-op` test adapter to check everything is working. -```python3 -m grizzly no-op``` +``` +python3 -m grizzly no-op +``` **Reduce** - [Grizzly Reduce](https://github.com/MozillaSecurity/grizzly/wiki/Grizzly-Reduce) can reduce a test case. -```python3 -m grizzly.reduce ``` +``` +python3 -m grizzly.reduce +``` **Replay** - [Grizzly Replay](https://github.com/MozillaSecurity/grizzly/wiki/Grizzly-Replay) can replay a test case with different builds and debuggers. -```python3 -m grizzly.replay ``` +``` +python3 -m grizzly.replay +``` + +[Bugzilla](https://bugzilla.mozilla.org/) is also supported by Grizzly Replay. Bugs can be replayed via a bug ID: + +``` +python3 -m grizzly.replay.bugzilla +``` + +Questions +--------- + +Common questions can be found on the [Q&A](https://github.com/MozillaSecurity/grizzly/wiki/Q&A) page. +Questions can also be asked in the [#fuzzing](https://riot.im/app/#/room/#fuzzing:mozilla.org) channel. + +Please be sure you are using the latest version Grizzly before reporting issues.