README.md in ronin-2.0.0.beta1 vs README.md in ronin-2.0.0.beta2
- old
+ new
@@ -11,11 +11,22 @@
[Twitter](https://twitter.com/ronin_rb) |
[Mastodon](https://infosec.exchange/@ronin_rb)
## Description
-[Ronin][ronin-rb] is a [Ruby] toolkit for security research and development.
+[Ronin][website] is a free and Open Source [Ruby] toolkit for security research
+and development. Ronin contains many different [CLI commands](#snopsis) and
+[Ruby libraries][ronin-rb] for a variety of security tasks, such as
+encoding/decoding data, filter IPs/hosts/URLs, querying ASNs, querying DNS,
+HTTP, [scanning for web vulnerabilities][ronin-vulns-synopsis],
+[spidering websites][ronin-web-spider],
+[install 3rd party repositories][ronin-repos-synopsis] of
+[exploits][ronin-exploits] and/or
+[payloads][ronin-payloads], [run exploits][ronin-exploits-synopsis],
+[write new exploits][ronin-exploits-examples],
+[managing local databases][ronin-db-synopsis],
+[fuzzing data][ronin-fuzzer], and much more.
### Who is Ronin for?
* CTF players
* Bug bounty hunters
@@ -137,12 +148,28 @@
```shell
$ ronin irb
```
+### See Also
+
+* [ronin-repos](https://github.com/ronin-rb/ronin-repos#synopsis)
+* [ronin-db](https://github.com/ronin-rb/ronin-db#synopsis)
+* [ronin-web](https://github.com/ronin-rb/ronin-web#synopsis)
+* [ronin-fuzzer](https://github.com/ronin-rb/ronin-fuzzer#synopsis)
+* [ronin-payloads](https://github.com/ronin-rb/ronin-payloads#synopsis)
+* [ronin-exploits](https://github.com/ronin-rb/ronin-exploits#synopsis)
+* [ronin-vulns](https://github.com/ronin-rb/ronin-vulns#synopsis)
+
## Requirements
+* [gcc] / [clang]
+* [make]
+* [git]
+* [libsqlite3]
+* [libxml2]
+* [libxslt]
* [Ruby] >= 3.0.0
* [open_namespace] ~> 0.4
* [rouge] ~> 3.0
* [async-io] ~> 1.0
* [wordlist] ~> 1.0
@@ -158,14 +185,40 @@
* [ronin-exploits] ~> 1.0
* [ronin-vulns] ~> 0.1
## Install
+### Bash Script
+
```shell
+curl -o ronin-install.sh https://raw.githubusercontent.com/ronin-rb/scripts/main/ronin-install.sh && bash ronin-install.sh
+```
+
+### Manually
+
+```shell
$ gem install ronin
```
+### Docker
+
+If you prefer using [Docker], there are also [Docker images] available:
+
+```shell
+docker pull roninrb/ronin
+docker run -it ronin
+```
+
+Additionally, if you want to mount your home directory into the docker image:
+
+```shell
+docker run --mount type=bind,source="$HOME",target=/home/ronin -it ronin
+```
+
+[Docker]: https://www.docker.com/
+[Docker images]: https://hub.docker.com/r/roninrb/ronin
+
## Development
1. [Fork It!](https://github.com/ronin-rb/ronin/fork)
2. Clone It!
3. `cd ronin`
@@ -190,25 +243,40 @@
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Ronin. If not, see <https://www.gnu.org/licenses/>.
-[ronin-rb]: https://ronin-rb.dev/
+[website]: https://ronin-rb.dev/
+[ronin-rb]: https://github.com/ronin-rb/
+
+[gcc]: http://gcc.gnu.org/
+[clang]: http://clang.llvm.org/
+[git]: https://git-scm.com/
+[make]: https://www.gnu.org/software/automake/
+[libxml2]: https://gitlab.gnome.org/GNOME/libxml2/-/wikis/home
+[libxslt]: http://xmlsoft.org/libxslt/index.html
+[libsqlite3]: https://www.sqlite.org/index.html
[Ruby]: https://www.ruby-lang.org
[open_namespace]: https://github.com/postmodern/open_namespace#readme
[rouge]: https://github.com/rouge-ruby/rouge#readme
[async-io]: https://github.com/socketry/async-io#readme
[wordlist]: https://github.com/postmodern/wordlist.rb#readme
[ronin-support]: https://github.com/ronin-rb/ronin-support#readme
[ronin-repos]: https://github.com/ronin-rb/ronin-repos#readme
+[ronin-repos-synopsis]: https://github.com/ronin-rb/ronin-repos#synopsis
[ronin-core]: https://github.com/ronin-rb/ronin-core#readme
[ronin-db]: https://github.com/ronin-rb/ronin-db#readme
+[ronin-db-synopsis]: https://github.com/ronin-rb/ronin-db#synopsis
[ronin-fuzzer]: https://github.com/ronin-rb/ronin-fuzzer#readme
[ronin-web]: https://github.com/ronin-rb/ronin-web#readme
+[ronin-web-server]: https://github.com/ronin-rb/ronin-web-server#readme
+[ronin-web-spider]: https://github.com/ronin-rb/ronin-web-spider#readme
+[ronin-web-user_agents]: https://github.com/ronin-rb/ronin-web-user_agents#readme
[ronin-code-asm]: https://github.com/ronin-rb/ronin-code-asm#readme
[ronin-code-sql]: https://github.com/ronin-rb/ronin-code-sql#readme
[ronin-payloads]: https://github.com/ronin-rb/ronin-payloads#readme
[ronin-exploits]: https://github.com/ronin-rb/ronin-exploits#readme
+[ronin-exploits-synopsis]: https://github.com/ronin-rb/ronin-exploits#synopsis
+[ronin-exploits-examples]: https://github.com/ronin-rb/ronin-exploits#examples
[ronin-vulns]: https://github.com/ronin-rb/ronin-vulns#readme
-
-[git]: https://git-scm.com/
+[ronin-vulns-synopsis]: https://github.com/ronin-rb/ronin-vulns#synopsis