History

Niboucha Redouane 3df276230a write whole FTP link, looks like some browsers dropped FTP support, and markdown does not render it as a link		2020-08-13 15:19:33 +02:00
..
api/v1	Land #10675 , DB manager for payloads: Resolve conflicts, add 'create!' to trigger database write	2019-03-04 14:58:03 -06:00
cli	Typo fix	2019-03-01 10:43:36 -06:00
modules	write whole FTP link, looks like some browsers dropped FTP support, and markdown does not render it as a link	2020-08-13 15:19:33 +02:00
README.md	Squashed commit of the following:	2014-12-01 11:57:43 -06:00
developers_guide.pdf	Restore the hallowed developer's guide	2014-12-03 16:50:18 -06:00

README.md

Metasploit Developer Documentation

*(last updated December 1, 2014)

Metasploit is actively supported by a community of hundreds of contributors and thousands of users world-wide. As a result, the accompanying documentation moves quite quickly.

The best source of documentation on Metasploit development is https://github.com/rapid7/metasploit-framework/wiki. There are many treasures there, such as:

...and many, many more.

API Documentation

If you are looking for API documentation, you may run rake yard to generate a navigatable view of the comment documentation used throughout Metasploit, or visit https://rapid7.github.io/metasploit-framework/api for a recently generated online version.

Contributing

If you would like to contribute to the documentation effort, please see http://yardoc.org/ for details on how to write YARD-compatible comments, and send us a Pull Request with your contribution.