Skip to content

Commit d9fc9fa

Browse files
committed
Update README.md to modernize the links to point to the new docs.metasploit.com website, remove links that weren't being used, and improve explanations in some locations
1 parent e0dcea8 commit d9fc9fa

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

Diff for: README.md

+17-12
Original file line numberDiff line numberDiff line change
@@ -3,47 +3,52 @@ Metasploit [![Build Status](https://travis-ci.org/rapid7/metasploit-framework.sv
33
The Metasploit Framework is released under a BSD-style license. See
44
[COPYING](COPYING) for more details.
55

6-
The latest version of this software is available from: https://metasploit.com
6+
The latest version of this software is available from: https://docs.metasploit.com/docs/using-metasploit/getting-started/nightly-installers.html
77

8-
Bug tracking and development information can be found at:
9-
https://github.com/rapid7/metasploit-framework
8+
You can find documentation on Metasploit and how to use it at:
9+
https://docs.metasploit.com/
10+
11+
Information about setting up a development environment can be found at:
12+
https://docs.metasploit.com/docs/development/get-started/setting-up-a-metasploit-development-environment.html
13+
14+
Our bug and feature request tracker can be found at:
15+
https://github.com/rapid7/metasploit-framework/issues
1016

1117
New bugs and feature requests should be directed to:
1218
https://r-7.co/MSF-BUGv1
1319

1420
API documentation for writing modules can be found at:
15-
https://rapid7.github.io/metasploit-framework/api
21+
https://docs.metasploit.com/api/
1622

1723
Questions and suggestions can be sent to: Freenode IRC channel or e-mail the metasploit-hackers mailing list
1824

1925
Installing
2026
--
2127

22-
Generally, you should use [the free installer](https://github.com/rapid7/metasploit-framework/wiki/Nightly-Installers),
28+
Generally, you should use [the free installer](https://docs.metasploit.com/docs/using-metasploit/getting-started/nightly-installers.html),
2329
which contains all of the dependencies and will get you up and running with a
24-
few clicks. See the [Dev Environment Setup](https://r-7.co/MSF-DEV) if
30+
few clicks. See the [Dev Environment Setup](https://docs.metasploit.com/docs/development/get-started/setting-up-a-metasploit-development-environment.html) if
2531
you'd like to deal with dependencies on your own.
2632

2733
Using Metasploit
2834
--
2935
Metasploit can do all sorts of things. The first thing you'll want to do
3036
is start `msfconsole`, but after that, you'll probably be best served by
3137
reading [Metasploit Unleashed][unleashed], the [great community
32-
resources](https://metasploit.github.io), or the [wiki].
38+
resources](https://metasploit.github.io), or take a look at the
39+
[Using Metasploit](https://docs.metasploit.com/docs/using-metasploit/basics/using-metasploit.html)
40+
page on the documentation website.
3341

3442
Contributing
3543
--
36-
See the [Dev Environment Setup][wiki-devenv] guide on GitHub, which will
44+
See the [Dev Environment Setup][devenv] guide on GitHub, which will
3745
walk you through the whole process from installing all the
3846
dependencies, to cloning the repository, and finally to submitting a
3947
pull request. For slightly more information, see
4048
[Contributing](https://github.com/rapid7/metasploit-framework/blob/master/CONTRIBUTING.md).
4149

4250

43-
[wiki]: https://github.com/rapid7/metasploit-framework/wiki
44-
[wiki-devenv]: https://github.com/rapid7/metasploit-framework/wiki/Setting-Up-a-Metasploit-Development-Environment "Metasploit Development Environment Setup"
45-
[wiki-start]: https://github.com/rapid7/metasploit-framework/wiki/ "Metasploit Wiki"
46-
[wiki-usage]: https://github.com/rapid7/metasploit-framework/wiki/Using-Metasploit "Using Metasploit"
51+
[devenv]: https://docs.metasploit.com/docs/development/get-started/setting-up-a-metasploit-development-environment.html "Metasploit Development Environment Setup"
4752
[unleashed]: https://www.offensive-security.com/metasploit-unleashed/ "Metasploit Unleashed"
4853

4954

0 commit comments

Comments
 (0)