From bfe1e9f7f51b8ebb7aa1a8dce42bd91ba24523a4 Mon Sep 17 00:00:00 2001
From: Florian Carrier <Akaizoku@users.noreply.github.com>
Date: Mon, 13 Jan 2020 10:31:23 +0000
Subject: [PATCH] Update project documentation

---
 CHANGELOG.md |  23 +++++++++++++--
 LICENSE      |   2 +-
 PSWF.psd1    | Bin 7914 -> 3864 bytes
 README.md    |  82 ++++++++++++++++++++++++++++++++++++++++++++++++++-
 4 files changed, 103 insertions(+), 4 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 9f8a6ed..c91182f 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,26 +4,45 @@ All notable changes to the [PSWF](https://github.com/Akaizoku/PSWF) project will
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.0.1](https://github.com/Akaizoku/PSWF/releases/tag/1.0.0) - 2019-12-20
+## [1.0.0](https://github.com/Akaizoku/PSWF/releases/tag/1.0.0) - 2020-01-13
 
 ### Added
 
 The following functions have been added:
 -   Add-DataSource
+-   Add-JDBCDriver
+-   Add-Module
 -   Add-SecurityRole
 -   Add-User
--   Assert-JBossCliCmdOutcome
+-   Add-UserGroupRole
 -   Disable-RBAC
 -   Enable-RBAC
 -   Grant-SecurityRole
+-   Invoke-DeployWAR
 -   Invoke-JBossClient
 -   Invoke-ReloadServer
+-   Invoke-UndeployWAR
+-   Read-DeploymentStatus
+-   Read-Resource
 -   Read-ServerState
+-   Remove-DataSource
+-   Remove-JDBCDriver
+-   Remove-Module
+-   Remove-Resource
+-   Remove-SecurityRole
+-   Remove-User
+-   Remove-UserGroupRole
 -   Resolve-ServerState
 -   Set-Interface
 -   Set-JavaOptions
 -   Set-PortNumber
 -   Set-PortOffset
+-   Test-JBossClientOutcome
+-   Test-Module
+-   Test-SecurityRole
+-   Test-ServerState
+-   Test-User
+-   Test-UserGroupRole
 
 The following files have been added:
 -   CHANGELOG
diff --git a/LICENSE b/LICENSE
index e98fa9c..df51100 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Florian Carrier
+Copyright (c) 2019-2020 Florian Carrier
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/PSWF.psd1 b/PSWF.psd1
index 76e039637487f9df5efecf3ad47d81a8606103c5..9d2dbf9b1b2ce3a8b67049fa3a48c6f25d3bca64 100644
GIT binary patch
literal 3864
zcmc&%-EP}97`@k1d_XRo46*FEN%{j6sF%cTh9nD;wB0QwQ8pKeR7uK?H}uJNu}9h~
z?2wWr*>Qtrz_#49mdNv+@BiqpKmObacIZ+iWyUFIQl#8iN|mO(de*zX{XFRf?$moO
zxn`Cp6fNJ-BvV>2NheHe!S%)oCEw6+G&mRyM#F>Gcp1F=JpjgStVLm0;4l*j$@Fsd
zAQhm&j8U=hh8Duk$j*dmxP`%uQnn`imOQ<%F!@2x!GGe~2qj6DdBioTw7%?p34`j|
z>JV-pgu`&?Z{C(gp|o@E`t~dl7AOXQCn_(P6;a09$Mlxo?d~~q=ciN}T(OEuDZZ3E
zTark)v?5)0EeG#E;;6HCbo?q#Msfee>z7CU!)SQikD~NtKYn@0UmP9sbT~TlbjGEf
zAv)_01ocw@ZA9PS@m%GSaBt3K^7wjv;ELtkk=c$>EVY=<EE$Uo<nYB;LzM#`#^6M)
z&H!XL-XoXd{%ANFZWcvI<18bOXGn9y^_(Z6Cwt0`F9nw^?<J?Sl(CCD%Y<E0q17C*
zbj7w7${p%n1p^OvDWu5D9FA87P(yweh{M9rwOVj}JL6!(<y1%xHeX7ix52k(JB8wn
z_`rP|d8W`h--G)B2UkgWCi`dE*yO(@NS7kk%Ba**cy)G16OGzfD1HAeKSH{5-B@Vu
z9W}yo!tXh9mehs9yU|9j?yV|_S1m<KX3G$rbE@nWw~e{)U}|TaVwLBpmyF42$)-qR
ziB>}~@19)T?ETx6VPli#wN^35w9>?MJVPvETWZj`Qj+h}FRzaGX`Cm=hu`FeNHiGZ
zE<{t;zU2%$fMIHuD6j|t&+AboBqomw%rsLGbG1DeT1nrvg%;q2_tj}3ryFf_Q+Gf$
z6iqwT#>VhG$^_pqn<?h{@w<ULIL*YY=f9ithITQy5B4hG7~+O>l91k^m}ME)J@X8g
zTv=7{=1$d7ZJoMX7ML)t*@rxXW#z(I`?Z*HnD?Q594vQz8|*~s9GUs&z!ktY=v7{t
z6k;)w#Ck>!^13YQVO0GjQ}9@%0`C#Uc1;c{q$Vhc)0Kx=S!l8|sV6WJuZTamDx*}Z
zyjwZ@zRe>i6AG@O6rdVnRC}UGD(m(kEku^YOecnzOja)vo^cEdSFKnodb#h9LO}4m
zz_^EsU|61RVPmx5CkI@!5;}y!pkaBZ&MJ=RmLL2eJ;@VT>74$5>BpON!k}jOnEEFM
zIR%~Z6#1Yz^!WZb6U;n$`#;Sb7Q#B6FsK<mrha;Rg5hmcsWDBTC_T3~OnkFC*#WBc
z*o8n<q9-ssnieToe2-m`peh?JS?QRS?)A5t9_V6JZT%F&1QTWb{<Ri!C?`soWzLrZ
za@PIp3jcY1TJPE%eZexLu>GWE=xhdwdg{<;%*?E-naVeoR7)0%pf;3q%RCRSQX!;T
zZ4(AHQI7=gA<qeaHFW#HJ=~!?HbplV1-62hyB$5~XhPZ%)KyUtsjVl%#A?o=?m-%h
z-^s42pX*pHp||G1J+upduVvTUr`~5wkx906|NZGlWsLhzy3!}^M`?vqiakhihvWWs
zXiOh(E>`i*M9d|qx$l`S<Ieeu>c~eeoFv8&sem3q<u39I9(l#n;6bGRilyH=gT3P(
z)NnIv3-e|$n4<K`D1>|&jPIHFP2HD+>bq*2Im|?XT%#o*vyA(iSl`{PHGF~K;5P0z
zn6~J@D`nA9eoMG-sH*N;57$n$?teub&oH@hZ?n>Zp!>2a_4QhG-$fr#3g<Fa$i?}l
z_4ciMxzahOJY{8um7;kn9(=-_*u(yS1n@&1b+@^SLi!oyrSX;EyDM48D2<ETxnJo0
ZOYb`MuRXq3pw(%76FDo@^P0}r;BTCq4^RLA

literal 7914
zcmeI1Yj0ac5Qg_N692(cJ~&0hX?g`DB&?)qBekV!(w47|Z<xjxY^P~J{p-N{%y_$J
zeU2SBN&z8c+2^vmv+vwz)_?x76}}8#gso5u&%!u#!g)9gT|Es$D~!S*^z<|fbG_+l
zd}<@bdG+uj9EUgIFw_^6BE832InsA3N^@O1T6-EU!*{wKY8R*tY?oTt*L7;o%y$aw
z=!``fI=91}up9R5_l}<S!ncLhQ1~JIZf_#B<IuK!CdSh+<JtK;6{?Zpxh!$p)0oSr
zC8^A`x@|l}{x0-14?k-izXQ!EOR`~jUTW=FvvR3_ulY%$jW7{~p}2C{Mjl?9RA-`(
z9BTTWYu2f~t?6BFY5$}z-@CZyGA&1NJ2WKCMrr3`?KIH`NkyK~|08J^&K=Qgp#$_f
z7P5(1z(5F*UDf<rVBa6YcDR*k>nI%P{kf#z_A?hfp0Uhdb?u5GS{i77tPKP`dsCEu
z;vWe<4zGgKbzb+v{qP`sBTaT>NA0i^?#hZD>g`UrC(O4sx})o<C_mI)Tfg_T+g;7z
z+A}M>zoet4(1F2iYMoBNl+Sit>wP4*h$QEcaqqjnGnsTY#E{c?E}adv-ZfLd!eh&5
zCc=S#_ay_O2QkFs094UbiYTjf1*T<6E}d=Z;g)DbufHm$G&Hv<YdO<3;le+s!h?NH
z1M=#~>T_-mY&=Dc=yge_NU3L5*%n_u-qKEZ1lBnb?Xjr4mBu)j$B5iUx3p^2zRrJ+
z@tJ7j6GNdGYAu{h#Z@)dH#Qr)xX_%MJd!(B97|jH6jDM<eVYk?NC}S{*xjZ)R8g*u
zI5|Jb`f@36h8(Z+oON@kpDbu5WPg_)J|{Pu=wdV5VirDv<k1=a-3ZT>8BTO}s1c7R
z7aE<0x1VfL`0vTboQg+buhAy4bn+3I0E>R7-S9u`G}bLd8D>=3Wc0STqC&*M`imKj
ztU40KOYs!5@PXdV#bH;!W&UnXvJrP%`wjK+oPQ<`@y~Nz`^MMQA`tP%<My_)@6+(o
zqGXa3cUO7uzfacA$tE&=A*-M&Bc@}CRIJpNZL=M0gcyBpwo_BR@!aIu4PR^CPpSeQ
z*j-aH?CAd9HKZ5qql~1v5=V6`NjU+V#tz7!RFqUi+)?vk^VC@I3V&#qY~Zz0w4T1K
zcdYsNg~xXC5waSYy?92(ugDol&DR%cL$z-sskTiRBi}EDp_nO()h2wvYq`>En!dWi
zLX|iWjrBakO-sBwzn=qlHKJ<tc~=p;1UT4M#Gs1bGfPT3#3ntjQq8)?T*tg^o1Una
zr>aJvLpHu?jip#t#6MG<9V<!}{b-feP81O*#z!^J@1@VP1?N=mZm+rSE-Ws)43Zsh
zW@~Z(Pr-a>_Dz3_2mLd+ix@ry`?4>UeUxa2z0i3RBiuj88nL%$G_R_Pqg3i>l)e_(
zq<B(OE-Ck{yIBWYwwxFh$deJzG8ff8b!ho4Rn*{ie!JoQ$9RVZu~e#FyeszHiC-dn
ztO2k;kDTy0UA*_R4sr%_sf&>x***52HPy#-{vGqosji?Q0~2lY6~rVw*XxlOf4%3K
z%3s*SJ6flJZ)5k~EBHA`%lZa15MzQzix@RP2Uo<7t0d%JUX~`hdX!1hv(Q&d{m;J8
zbru}`uLG|ph|#Wt_Lb6c`R7vHRQ9iBV}45JXD8Q{KVDd-wJ8evW=`tplCO*4zw3qG
zX{?iuTR<+wO=W+eo_t@{hW}H~Qn`9{d%b8F<MDy0wH48qsaE4E*K1EL(h?y(mmq~R
zJr#2aw!+z8Tm7DQDMZWaGtv~VBf?^qNV`?%iZq_1DQ5TUBRRC#-&Hq7c7f+=6x2)u
z>pea8cf>WPUQtsZpeu>bF*g)tcGLMc@8!sJoJgT9tcgmK4gi!?T#V2mAM5lfVyEkv
zDYG)iqfk+Y)ZoQV8Opg8@I*FbW~7-;booc1x+iz9$z_^QxdzhNeoa*P<k(luinF)0
z;zX$Wrj?egbt3$+>Y1B_s;i19SNw-;;OAzX93=bB^@^16IZgtpJ^b7nnfuuS@`qAi
zc<?3Wcpv1Fh?wIw;f~hGKL_QLyt-8!b^S-<6%6Ofm&)-(<htSsCkF6L{ZUt~j{otE
z`@}1<YU=w+QRAtuNjjj00&!`ykVmYzR!MKw4)|E2^U7op&!E#8VZ;=#>#<?=Zrz-6
zo(f?+Eh?j=lN^U%G>^KfTJqi-#W^`f{A4aGn(6<kU41w~MF!{Ew_(~J>TS~^;voE{
zz20hU*X%a^i?&KSW%*Ns(mlE#d!B#?w@W;GeJ54TA@V$0(9HQ;uLJT4mh0J&vlSvC
z5ifNd<qCZjx2vgP@pXMzSzP@=@4@~^QX$v)u6ax-$FoRf)#_qYPZ4M}9S}S*NlYZg
zk#!mFH%A{aRr>`<s#fE3tX<}tx%^Mi3oTjEnWXLiHt=Sk+CFtY@$}Gp7Bo`qqP)wy
zs*@t-{kVu;$b?RZIN;~1Jgvq-#E+JEq>K>Ht9G*fv8Mmm@UDp8t+UMKzBJ2OsB=?X
LQI^pMvyi_4+8zx;

diff --git a/README.md b/README.md
index 0ee16db..87e42f1 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,83 @@
 # WildFly PowerShell Module
 
-WildFly PowerShell Module (PSWF) is a collection of useful functions and procedures to manage WildFly using PowerShell.
+WildFly PowerShell Module (PSWF) is a framework to manage WildFly using PowerShell.
+
+<!-- TOC depthFrom:2 depthTo:6 withLinks:1 updateOnSave:1 orderedList:1 -->
+
+1.  [Usage](#usage)
+    1.  [Installation](#installation)
+    2.  [Import](#import)
+    3.  [List available functions](#list-available-functions)
+2.  [Dependencies](#dependencies)
+3.  [Roadmap](#roadmap)
+
+<!-- /TOC -->
+
+## Usage
+
+### Installation
+
+There are two ways of setting up the WildFly PowerShell Module on your system:
+1. Download the PSWF module from the [Github repository](https://github.com/Akaizoku/PSWF);
+1. Install the PSWF module from the [PowerShell Gallery](https://www.powershellgallery.com/packages/PSWF).
+
+```powershell
+Install-Module -Name "PSWF" -Repository "PSGallery"
+```
+
+### Import
+
+```powershell
+Import-Module -Name "PSWF"
+```
+
+### List available functions
+
+```powershell
+Get-Command -Module "PSWF"
+```
+
+| CommandType     | Name                                               | Version    | Source |
+| -----------     | ----                                               | -------    | ------ |
+| Function        | Add-DataSource                                     | 1.0.0      | PSWF |
+| Function        | Add-JDBCDriver                                     | 1.0.0      | PSWF |
+| Function        | Add-Module                                         | 1.0.0      | PSWF |
+| Function        | Add-SecurityRole                                   | 1.0.0      | PSWF |
+| Function        | Add-User                                           | 1.0.0      | PSWF |
+| Function        | Add-UserGroupRole                                  | 1.0.0      | PSWF |
+| Function        | Disable-RBAC                                       | 1.0.0      | PSWF |
+| Function        | Enable-RBAC                                        | 1.0.0      | PSWF |
+| Function        | Grant-SecurityRole                                 | 1.0.0      | PSWF |
+| Function        | Invoke-DeployWAR                                   | 1.0.0      | PSWF |
+| Function        | Invoke-JBossClient                                 | 1.0.0      | PSWF |
+| Function        | Invoke-ReloadServer                                | 1.0.0      | PSWF |
+| Function        | Invoke-UndeployWAR                                 | 1.0.0      | PSWF |
+| Function        | Read-DeploymentStatus                              | 1.0.0      | PSWF |
+| Function        | Read-Resource                                      | 1.0.0      | PSWF |
+| Function        | Read-ServerState                                   | 1.0.0      | PSWF |
+| Function        | Remove-DataSource                                  | 1.0.0      | PSWF |
+| Function        | Remove-JDBCDriver                                  | 1.0.0      | PSWF |
+| Function        | Remove-Module                                      | 1.0.0      | PSWF |
+| Function        | Remove-Resource                                    | 1.0.0      | PSWF |
+| Function        | Remove-SecurityRole                                | 1.0.0      | PSWF |
+| Function        | Remove-User                                        | 1.0.0      | PSWF |
+| Function        | Remove-UserGroupRole                               | 1.0.0      | PSWF |
+| Function        | Resolve-ServerState                                | 1.0.0      | PSWF |
+| Function        | Set-Interface                                      | 1.0.0      | PSWF |
+| Function        | Set-JavaOptions                                    | 1.0.0      | PSWF |
+| Function        | Set-PortNumber                                     | 1.0.0      | PSWF |
+| Function        | Set-PortOffset                                     | 1.0.0      | PSWF |
+| Function        | Test-JBossClientOutcome                            | 1.0.0      | PSWF |
+| Function        | Test-Module                                        | 1.0.0      | PSWF |
+| Function        | Test-SecurityRole                                  | 1.0.0      | PSWF |
+| Function        | Test-ServerState                                   | 1.0.0      | PSWF |
+| Function        | Test-User                                          | 1.0.0      | PSWF |
+| Function        | Test-UserGroupRole                                 | 1.0.0      | PSWF |
+
+## Dependencies
+
+The WildFly PowerShell Module requires the [PowerShell Tool Kit module (PSTK)](https://www.powershellgallery.com/packages/PSTK).
+
+## Roadmap
+
+-   [ ] Add functions to configure logs