From cf05132c3f0b9ba405e47ba1ceb1ad98f3329e7f Mon Sep 17 00:00:00 2001 From: Christoph Hartmann Date: Mon, 3 Jun 2024 11:38:52 +0200 Subject: [PATCH] Update description & documentation Co-authored-by: Tim Smith --- Makefile | 2 +- providers/defaults.go | 2 +- providers/nmap/README.md | 4 ++-- providers/nmap/config/config.go | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/Makefile b/Makefile index 2243922fa0..8918a56f14 100644 --- a/Makefile +++ b/Makefile @@ -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 \ diff --git a/providers/defaults.go b/providers/defaults.go index 07c6c98177..742d3dafe0 100644 --- a/providers/defaults.go +++ b/providers/defaults.go @@ -254,7 +254,7 @@ var DefaultProviders Providers = map[string]*Provider{ { Name: "nmap", Use: "nmap", - Short: "a nmap network scanner", + Short: "a Nmap network scanner", }, }, }, diff --git a/providers/nmap/README.md b/providers/nmap/README.md index 1271524387..5bbcd3e39a 100644 --- a/providers/nmap/README.md +++ b/providers/nmap/README.md @@ -1,4 +1,4 @@ -# 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. @@ -6,7 +6,7 @@ The nmap provider maps primary objects and attributes that nmap uses to store an ## 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 diff --git a/providers/nmap/config/config.go b/providers/nmap/config/config.go index 4647e203a1..9d5169e85c 100644 --- a/providers/nmap/config/config.go +++ b/providers/nmap/config/config.go @@ -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{}, },