infosecn1nja
/
metasploit-framework
mirror of https://github.com/infosecn1nja/metasploit-framework.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
metasploit-framework/documentation
History
h00die af7d76b52d changes from first review 2018-09-14 20:10:59 -04:00
..
api/v1 Add examples for username and password properties 2018-08-15 16:34:11 -05:00
modules changes from first review 2018-09-14 20:10:59 -04: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.