Update project documentation

Akaizoku · Jan 13, 2020 · bfe1e9f · bfe1e9f
1 parent 8fd01a2
commit bfe1e9f
Show file tree

Hide file tree

Showing 4 changed files with 103 additions and 4 deletions.
diff --git 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
@@ -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
diff --git 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