Skip to content

Commit

Permalink
Updated the project description.
Browse files Browse the repository at this point in the history
  • Loading branch information
postmodern committed Sep 9, 2023
1 parent c2d1cce commit b406d58
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 2 deletions.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,18 @@
## Description

ronin-repos provides a repository system for installing, managing, and accessing
third-party git repositories, which can contain code or other data.
third-party git repositories, that can contain additional Ruby code or other
data.

Third-party git repositories can be used to extend parts of Ronin. Other Ronin
libraries can then list and load additional third-party Ruby classes from
specific directories within the installed third-party repos:

* `exploits/` - may contain additional exploits for [ronin-exploits].
* `payloads/` - may contain additional payloads for [ronin-payloads].

**tl;dr** ronin-repos is essentially a decentralized plugin system for Ronin
using git repos.

ronin-repos is part of the [ronin-rb] project, a toolkit for security research
and development.
Expand Down Expand Up @@ -157,3 +168,5 @@ along with ronin-repos. If not, see <https://www.gnu.org/licenses/>.
[Ruby]: https://www.ruby-lang.org
[git]: https://git-scm.com/
[ronin-core]: https://github.com/ronin-rb/ronin-core#readme
[ronin-exploits]: https://github.com/ronin-rb/ronin-exploits#readme
[ronin-payloads]: https://github.com/ronin-rb/ronin-payloads#readme
8 changes: 7 additions & 1 deletion gemspec.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@ name: ronin-repos
summary: Third-party git repository support for ronin.
description:
ronin-repos provides a repository system for installing, managing, and
accessing third-party git repositories, which can contain code or other data.
accessing third-party git repositories, that can contain additional Ruby code
or other data. Other Ronin libraries, such as ronin-exploits or
ronin-payloads, can then list and load additional third-party Ruby classes
from specific directories within the installed third-party reposs.

ronin-repos is essentially a decentralized plugin system for Ronin using git
repos.

license: LGPL-3.0
authors: Postmodern
Expand Down

0 comments on commit b406d58

Please sign in to comment.