Add docs for v0.0.1 release

davidski · Dec 22, 2016 · d32b285 · d32b285
1 parent e3eb6dc
commit d32b285
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,3 @@
+# 0.0.1 
+
+Initial PowerShell Gallery release
diff --git a/README.md b/README.md
@@ -1,5 +1,28 @@
-# Nessus
-Powershell module for working with Nessus 6
+[![Build Status](https://ci.appveyor.com/api/projects/status/github/davidski/PSNessus?svg=true)](https://ci.appveyor.com/project/davidski/PSNessus)
+
+# Introduction
+PowerShell module for working with the [Tenable Nessus](https://www.tenable.com/products/nessus-vulnerability-scanner) API.
+
+## Sample Use Cases
++ Retrieve the status of vulnerability scans
++ Retrieve the results of scans for processing in downstream systems
++ Launch individual scans as one-offs
+
+# Installation
+
+There's More Than One Way To Do It (TMTOWTDI), but one of the simplest is via 
+the [PowerShell Gallery](https://www.powershellgallery.com):
+
+```PowerShell
+Install-Module -Name PSNessus
+```
+
+Alternatively you can manually install the module by:
+
+1. Downloading a zip build from the release page.
+2. Unblocking and extracting the zip.
+3. From PowerShell in the extracted directory enter: `{PowerShell} Install-Module -Path .\PSNessus`
+
 
 # Example
 
@@ -29,4 +52,5 @@ Powershell module for working with Nessus 6
     Disconnect-Nessus 
 
 # Credits
+
 Functions based off of community scripts posted on the [Nessus forums]([https://discussions.nessus.org/docs/DOC-1186).