Skip to content

Commit 515680d

Browse files
committed
Update readme: Remove instructions on usage as script
2 parents 5611b00 + 93f9619 commit 515680d

File tree

1 file changed

+1
-27
lines changed

1 file changed

+1
-27
lines changed

README.md

+1-27
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ It can be used as a *Powershell Script* or *Module*.
88

99
- <a href="https://github.com/PowerShell/PowerShell#get-powershell" target="_blank" title="Powershell">Powershell v3</a>
1010
- `Windows`or `*nix` environment
11-
- User with `read` `write` `modify` (or `rwx`) permissions on script directory
1211

1312
## The similarities
1413

@@ -32,32 +31,7 @@ It can be used as a *Powershell Script* or *Module*.
3231

3332
## How to use
3433

35-
`Log-Rotate` can be used as a *script*, a *module*, or a *Task / Cron job* (as with *nix's logrotate).
36-
37-
### As a Script
38-
39-
1. Open `Log-Rotate.ps1` in your favourite text editor and add your configuration inside `$myConfig`:
40-
41-
```powershell
42-
$myConfig = @'
43-
##### Start adding Config here #####
44-
# Global options
45-
size 1M
46-
47-
# Block options
48-
"C:\inetpub\logs\iis\mylogs\*.log" D:\console.log {
49-
rotate 365
50-
dateext
51-
...
52-
}
53-
##### End adding #####
54-
'@
55-
```
56-
57-
2. Run the script:
58-
59-
- WinNT: Right click on the script in `Explorer` and select `Run with Powershell`. (should be present on Windows 7 and up). Alternatively, open `Command Prompt` in the script directory, and run `Powershell .\Log-Rotate.ps1`
60-
- *nix: Run `powershell ./Log-Rotate.ps1` or `pwsh ./Log-Rotate.ps1` depending on which version of powershell you're running.
34+
`Log-Rotate` can be used as a *module* or a *Task / Cron job* (as with *nix's logrotate).
6135

6236
### As a Module
6337

0 commit comments

Comments
 (0)