Skip to content

Commit 9448ec6

Browse files
committed
update README.md
1 parent 88e51d3 commit 9448ec6

1 file changed

Lines changed: 14 additions & 87 deletions

File tree

README.md

Lines changed: 14 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -53,39 +53,31 @@ Monkey365 is designed to simplify Microsoft cloud security assessments without r
5353

5454
---
5555

56-
# Quick Start
56+
# Get Started
5757

58-
Install Monkey365 from the PowerShell Gallery:
58+
Install the Monkey365 PowerShell module and run.
5959

60-
```powershell
61-
Install-Module -Name monkey365 -Scope CurrentUser
62-
```
63-
64-
Import the module:
60+
[Zero configuration](https://silverhack.github.io/monkey365/install/install-instructions/) and no external Microsoft modules are required.
6561

6662
```powershell
63+
Install-Module -Name monkey365 -Scope CurrentUser
6764
Import-Module monkey365
68-
```
69-
70-
Run a basic assessment:
65+
Invoke-Monkey365
7166
72-
```powershell
7367
$options = @{
74-
Instance = 'Microsoft365';
75-
Collect = 'SharePointOnline';
76-
PromptBehavior = 'SelectAccount';
77-
IncludeEntraID = $true;
78-
ExportTo = 'HTML';
68+
Instance = 'Microsoft365'
69+
Collect = 'ExchangeOnline'
70+
PromptBehavior = 'SelectAccount'
71+
IncludeEntraID = $true
72+
ExportTo = 'HTML'
7973
}
80-
$assets = Invoke-Monkey365 @options
81-
```
82-
83-
Get available options and examples:
8474
85-
```powershell
86-
Get-Help Invoke-Monkey365 -Detailed
75+
Invoke-Monkey365 @options
8776
```
8877

78+
> [!NOTE]
79+
> Monkey365 is distributed as a self-contained PowerShell module and includes all required dependencies. No additional Microsoft PowerShell modules are required.
80+
8981
---
9082

9183
# Introduction
@@ -96,71 +88,6 @@ The tool provides recommendations to help organizations strengthen their cloud s
9688

9789
---
9890

99-
# Installation
100-
101-
## PowerShell Gallery
102-
103-
Install the latest stable version:
104-
105-
```powershell
106-
Install-Module -Name monkey365 -Scope CurrentUser
107-
```
108-
109-
Install the latest prerelease version:
110-
111-
```powershell
112-
Install-Module -Name monkey365 -Scope CurrentUser -AllowPrerelease
113-
```
114-
115-
Update Monkey365:
116-
117-
```powershell
118-
Update-Module -Name monkey365 -Scope CurrentUser
119-
```
120-
121-
Force reinstall Monkey365:
122-
123-
```powershell
124-
Install-Module -Name monkey365 -Scope CurrentUser -Force
125-
```
126-
127-
> [!NOTE]
128-
> Monkey365 is distributed as a self-contained PowerShell module and includes all required dependencies. No additional Microsoft PowerShell modules are required.
129-
130-
## GitHub Releases
131-
132-
Download the latest release from the following page:
133-
134-
https://github.com/silverhack/monkey365/releases
135-
136-
After downloading the release package, extract the archive to a suitable directory.
137-
138-
Use the PowerShell `Unblock-File` cmdlet to unblock extracted files if required:
139-
140-
```powershell
141-
Get-ChildItem -Recurse C:\monkey365 | Unblock-File
142-
```
143-
144-
Import the module:
145-
146-
```powershell
147-
Import-Module monkey365
148-
```
149-
150-
If Monkey365 is not located in a `PSModulePath` directory, import it using an explicit path:
151-
152-
```powershell
153-
Import-Module C:\temp\monkey365
154-
```
155-
156-
Reimport the module into the current PowerShell session:
157-
158-
```powershell
159-
Import-Module C:\temp\monkey365 -Force
160-
```
161-
162-
---
163-
16491
# Authentication
16592

16693
Monkey365 supports multiple authentication methods for both interactive and automated assessments.

0 commit comments

Comments
 (0)