Browse Source

Added build status badge and fixed some markdown

pull/62/head
sup3rlativ3 5 years ago
parent
commit
7622e53962
1 changed files with 8 additions and 4 deletions
  1. +8
    -4
      Docs/Index.md

+ 8
- 4
Docs/Index.md View File

@@ -1,25 +1,29 @@
# NTFSSecurity # NTFSSecurity


[![Build status](https://ci.appveyor.com/api/projects/status/2gfb58t9qh655b8x?svg=true)](https://ci.appveyor.com/project/Sup3rlativ3/ntfssecurity)


Managing permissions with PowerShell is only a bit easier than in VBS or the command line as there are no cmdlets for most day-to-day tasks like getting a permission report or adding permission to an item. PowerShell only offers Get-Acl and Set-Acl but everything in between getting and setting the ACL is missing. This module closes the gap. Managing permissions with PowerShell is only a bit easier than in VBS or the command line as there are no cmdlets for most day-to-day tasks like getting a permission report or adding permission to an item. PowerShell only offers Get-Acl and Set-Acl but everything in between getting and setting the ACL is missing. This module closes the gap.


[Version History](https://github.com/raandree/NTFSSecurity/wiki/Version-History) [Version History](https://github.com/raandree/NTFSSecurity/wiki/Version-History)


## Installation ## Installation

You have two options: You have two options:


* Download the latest release from the [releases](https://github.com/raandree/NTFSSecurity/releases) section on GitHub. * Download the latest release from the [releases](https://github.com/raandree/NTFSSecurity/releases) section on GitHub.
* Download the module from the [PowerShell Gallery](https://www.powershellgallery.com/packages/NTFSSecurity): * Download the module from the [PowerShell Gallery](https://www.powershellgallery.com/packages/NTFSSecurity):
```
Install-Module -Name NTFSSecurity

```PowerShell
Install-Module -Name NTFSSecurity
``` ```


Further help can be found in How to install if you face difficulties getting this module installed. Further help can be found in How to install if you face difficulties getting this module installed.


## Documentation ## Documentation

The cmdlets are yet not documented completely so Get-Help will not show help for all the cmdlets. Providing documentation is planned though. The cmdlets are yet not documented completely so Get-Help will not show help for all the cmdlets. Providing documentation is planned though.


## Additional documentation is available:
## Additional documentation is available


[NTFSSecurity Tutorial 1 - Getting, adding and removing permissions](http://blogs.technet.com/b/fieldcoding/archive/2014/12/05/ntfssecurity-tutorial-1-getting-adding-and-removing-permissions.aspx)
[NTFSSecurity Tutorial 1 - Getting, adding and removing permissions](http://blogs.technet.com/b/fieldcoding/archive/2014/12/05/ntfssecurity-tutorial-1-getting-adding-and-removing-permissions.aspx)
[NTFSSecurity Tutorial 2 - Managing NTFS Inheritance and Using Privileges](http://blogs.technet.com/b/fieldcoding/archive/2014/12/05/ntfssecurity-tutorial-2-managing-ntfs-inheritance-and-using-privileges.aspx) [NTFSSecurity Tutorial 2 - Managing NTFS Inheritance and Using Privileges](http://blogs.technet.com/b/fieldcoding/archive/2014/12/05/ntfssecurity-tutorial-2-managing-ntfs-inheritance-and-using-privileges.aspx)

Loading…
Cancel
Save