Skip to content

Commit 731a7cc

Browse files
authored
Merge pull request #63 from geekwhocodes/master
Readme update
2 parents 4633976 + 12458da commit 731a7cc

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,6 @@
2525
---
2626

2727
- [Introduction](#introduction)
28-
- [Simple powershell module is very extensible and easy use.](#simple-powershell-module-is-very-extensible-and-easy-use)
29-
- [- Task Board - Board](#ullitask-board---boardliul)
3028
- [Modules](#modules)
3129
- [Installation](#installation)
3230
- [PowerShell Gallery](#powershell-gallery)
@@ -42,9 +40,15 @@
4240

4341
# Introduction
4442

45-
### Simple powershell module is very extensible and easy use.
43+
> **SimplePSLogger provides an easy yet powerful way to save or display your logs.**
4644
- Docs - [SimplePSLogger Documentation](https://spsl.geekwhocodes.me/)
4745
- Task Board - [Board](https://github.com/geekwhocodes/simple-ps-logger/projects/3)
46+
47+
### Features
48+
- Easy to use ⭐
49+
- Simple Configuration 👌
50+
- Built in Providers 💜
51+
- Extensible 🔥
4852
---
4953

5054
# Modules
@@ -64,7 +68,7 @@ Below is a table contains our modules including built in provider modules.
6468

6569
```powershell
6670
# Install pre-release version
67-
Install-Module -Name SimplePSLogger -AllowPrerelease
71+
Install-Module -Name SimplePSLogger -Confirm
6872
6973
```
7074

@@ -104,8 +108,11 @@ $MyLogger = New-SimplePSLogger -Name "Unique Name"
104108
String - plain text string
105109
OtherTypes - json serialized string
106110
#>
111+
107112
$MyLogger.Log('level', 'log message')
108113
114+
$MyLogger.Log("message") # In this case, SimplePSLogger will automatically use default(information) loglevel
115+
109116
$MyLogger.Dispose()
110117
111118
```
@@ -141,12 +148,12 @@ $MyLogger.Dispose()
141148

142149
### Issues
143150

144-
If you find any bugs when using this module, Please an issue on github
151+
If you find any bugs when using this module, Please an [issue on github](https://github.com/geekwhocodes/simple-ps-logger/issues)
145152

146153

147154
### Feedback
148155

149-
If there is a feature you would like to see in SimplePSLogger file an issue on github page.
156+
If there is a feature you would like to see in SimplePSLogger file an [issue on github](https://github.com/geekwhocodes/simple-ps-logger/issues)
150157

151158

152159

0 commit comments

Comments
 (0)