Skip to content

Commit

Permalink
Update description & documentation
Browse files Browse the repository at this point in the history
Co-authored-by: Tim Smith <tsmith84@gmail.com>
  • Loading branch information
chris-rock and tas50 committed Sep 9, 2024
1 parent 64427f3 commit cf05132
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -569,7 +569,7 @@ lr/docs/markdown: providers/lr
--output ../docs/docs/mql/resources/network-pack
./lr markdown providers/network/resources/nmap.lr \
--pack-name "nmap" \
--description "The nmap resource pack lets you use MQL to query and assess nmap data." \
--description "The Nmap resource pack lets you use MQL to query and assess Nmap data." \
--docs-file providers/network/resources/nmap.lr.manifest.yaml \
--output ../docs/docs/mql/resources/nmap-pack
./lr markdown providers/oci/resources/oci.lr \
Expand Down
2 changes: 1 addition & 1 deletion providers/defaults.go
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ var DefaultProviders Providers = map[string]*Provider{
{
Name: "nmap",
Use: "nmap",
Short: "a nmap network scanner",
Short: "a Nmap network scanner",
},
},
},
Expand Down
4 changes: 2 additions & 2 deletions providers/nmap/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# nmap provider
# Nmap provider

Nmap, short for Network Mapper, is a powerful and versatile open-source tool used for network discovery and security auditing. This tool is widely utilized by network administrators, security professionals, and penetration testers to map out network structures, discover hosts, identify services, and detect vulnerabilities.

The nmap provider maps primary objects and attributes that nmap uses to store and manage information about scanned targets, discovered hosts, and their associated ports and services.

## Pre-requisites

This provider requires the nmap tool to be installed on your system. You can download and install nmap from the official [website](https://nmap.org/download.html).
This provider requires the Nmap tool to be installed on your system. You can download and install Nmap from the official [website](https://nmap.org/download.html).

## Get Started

Expand Down
2 changes: 1 addition & 1 deletion providers/nmap/config/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ var Config = plugin.Provider{
{
Name: "nmap",
Use: "nmap",
Short: "a nmap network scanner",
Short: "a Nmap network scanner",
Discovery: []string{},
Flags: []plugin.Flag{},
},
Expand Down

0 comments on commit cf05132

Please sign in to comment.