Skip to content

Commit 03dc231

Browse files
authored
Merge pull request rapid7#19369 from Adithya2357/readme-update
Update README.md
2 parents 3ccf18f + 4a0d3d4 commit 03dc231

File tree

1 file changed

+32
-37
lines changed

1 file changed

+32
-37
lines changed

README.md

Lines changed: 32 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,47 @@
1-
Metasploit [![Maintainability](https://api.codeclimate.com/v1/badges/943e398e619c09568f3f/maintainability)](https://codeclimate.com/github/rapid7/metasploit-framework/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/943e398e619c09568f3f/test_coverage)](https://codeclimate.com/github/rapid7/metasploit-framework/test_coverage) [![Docker Pulls](https://img.shields.io/docker/pulls/metasploitframework/metasploit-framework.svg)](https://hub.docker.com/r/metasploitframework/metasploit-framework/)
2-
==
3-
The Metasploit Framework is released under a BSD-style license. See
4-
[COPYING](COPYING) for more details.
51

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

8-
You can find documentation on Metasploit and how to use it at:
9-
https://docs.metasploit.com/
4+
The Metasploit Framework is an open-source tool released under a BSD-style license. For detailed licensing information, refer to the `COPYING` file.
105

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
6+
## Latest Version
7+
Access the latest version of Metasploit from the [Nightly Installers](https://docs.metasploit.com/docs/using-metasploit/getting-started/nightly-installers.html) page.
138

14-
Our bug and feature request tracker can be found at:
15-
https://github.com/rapid7/metasploit-framework/issues
9+
## Documentation
10+
Comprehensive documentation, including usage guides, is available at [Metasploit Docs](https://docs.metasploit.com/).
1611

17-
New bugs and feature requests should be directed to:
18-
https://r-7.co/MSF-BUGv1
12+
## Development Environment
13+
To set up a development environment, visit the [Development Setup Guide](https://docs.metasploit.com/docs/development/get-started/setting-up-a-metasploit-development-environment.html).
1914

20-
API documentation for writing modules can be found at:
21-
https://docs.metasploit.com/api/
15+
## Bug and Feature Requests
16+
Submit bugs and feature requests via the [GitHub Issues](https://github.com/rapid7/metasploit-framework/issues) tracker. New submissions can be made through the [MSF-BUGv1 form](https://github.com/rapid7/metasploit-framework/issues/new/choose).
2217

23-
Questions and suggestions can be sent to: Freenode IRC channel or e-mail the metasploit-hackers mailing list
18+
## API Documentation
19+
For information on writing modules, refer to the [API Documentation](https://docs.metasploit.com/api/).
2420

25-
Installing
26-
--
21+
## Support and Communication
22+
For questions and suggestions, join the Freenode IRC channel or contact the metasploit-hackers mailing list.
2723

28-
Generally, you should use [the free installer](https://docs.metasploit.com/docs/using-metasploit/getting-started/nightly-installers.html),
29-
which contains all of the dependencies and will get you up and running with a
30-
few clicks. See the [Dev Environment Setup](https://docs.metasploit.com/docs/development/get-started/setting-up-a-metasploit-development-environment.html) if
31-
you'd like to deal with dependencies on your own.
24+
---
3225

33-
Using Metasploit
34-
--
35-
Metasploit can do all sorts of things. The first thing you'll want to do
36-
is start `msfconsole`, but after that, you'll probably be best served by
37-
reading the basics of [using Metasploit](https://docs.metasploit.com/docs/using-metasploit/basics/using-metasploit.html)
38-
or [Metasploit Unleashed][unleashed].
26+
## Installing Metasploit
3927

40-
Contributing
41-
--
42-
See the [Dev Environment Setup][devenv] guide on GitHub, which will
43-
walk you through the whole process from installing all the
44-
dependencies, to cloning the repository, and finally to submitting a
45-
pull request. For slightly more information, see
46-
[Contributing](https://github.com/rapid7/metasploit-framework/blob/master/CONTRIBUTING.md).
28+
### Recommended Installation
29+
We recommend installation with the [official Metasploit installers](https://docs.metasploit.com/docs/using-metasploit/getting-started/nightly-installers.html#installing-metasploit-on-linux--macos) on Linux or macOS. Metasploit is also pre-installed with Kali.
4730

31+
For a manual setup, consult the [Dev Environment Setup](https://docs.metasploit.com/docs/development/get-started/setting-up-a-metasploit-development-environment.html) guide.
4832

49-
[devenv]: https://docs.metasploit.com/docs/development/get-started/setting-up-a-metasploit-development-environment.html "Metasploit Development Environment Setup"
50-
[unleashed]: https://www.offensive-security.com/metasploit-unleashed/ "Metasploit Unleashed"
33+
## Using Metasploit
5134

35+
To get started with Metasploit:
5236

37+
1. **Start `msfconsole`:** This is the primary interface for interacting with Metasploit.
38+
2. **Explore Resources:**
39+
- Visit the [Using Metasploit](https://docs.metasploit.com/docs/using-metasploit/getting-started/index.html) section of the documentation.
40+
41+
## Contributing
42+
43+
To contribute to Metasploit:
44+
45+
1. **Setup Development Environment:** Follow the instructions in the [Development Setup Guide](https://docs.metasploit.com/docs/development/get-started/setting-up-a-metasploit-development-environment.html) on GitHub.
46+
2. **Clone the Repository:** Obtain the source code from the official repository.
47+
3. **Submit a Pull Request:** After making changes, submit a pull request for review. Additional details can be found in the [Contributing Guide](https://github.com/rapid7/metasploit-framework/blob/master/CONTRIBUTING.md).

0 commit comments

Comments
 (0)