Skip to content

Commit

Permalink
Add installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
sommd committed Apr 12, 2020
1 parent c08b4b7 commit ce6a57d
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

Rustmap is a very simple "Nmap-like" program that can scan for hosts and open TCP ports. It is mostly written for educational purposes (I wanted to learn Rust, and learn a bit more about how Nmap works) so it's quite slow and doesn't have many features.

## Installation

1. [Install Rust](https://www.rust-lang.org/tools/install)
2. `cargo install rustmap`

## Examples

Check if a single host is up:
Expand Down

0 comments on commit ce6a57d

Please sign in to comment.