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
Tim W 70a1df70a1
Land #9753, Linux BPF sign extension local privesc 		2018-07-18 18:44:14 +08:00
..
api/v1 Merge branch 'local_api_docs' of github.com:jbarnett-r7/metasploit-framework into local_api_docs 2018-05-29 12:33:30 -05:00
modules Land #9753, Linux BPF sign extension local privesc 2018-07-18 18:44:14 +08:00
README.md
…
developers_guide.pdf
…

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.