Skip to content

📖 [Docs]: README pages now use the standard module landing-page format #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Marius Storhaug (MariusStorhaug) wants to merge 1 commit into
base: main
Choose a base branch
from
Open

📖 [Docs]: README pages now use the standard module landing-page format #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 8 additions & 51 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,70 +1,27 @@
# Jwt

`Jwt` is a PowerShell module for creating and verifying JSON Web Tokens. This repository maintains the current `Jwt` module command surface under PSModule maintenance so existing users can continue to install and use the package from PowerShell Gallery.
Jwt is a PowerShell module for working with JSON Web Tokens.

## Installation

Install the module from the PowerShell Gallery:

```powershell
Install-PSResource -Name Jwt
Import-Module -Name Jwt
```

## Commands

The maintained module exports the same JWT commands and alias used by the current package:

```powershell
ConvertFrom-Base64UrlString
ConvertTo-Base64UrlString
Get-JwtHeader
Get-JwtPayload
New-Jwt
Test-Jwt
Verify-JwtSignature
```

## Usage

Create and validate an HMAC-signed JWT:

```powershell
$header = '{"alg":"HS256","typ":"JWT"}'
$payload = '{"sub":"1234567890","name":"John Doe","admin":true,"iat":1516239022}'
$secret = 'a-string-secret-at-least-256-bits-long'

$jwt = New-Jwt -Header $header -PayloadJson $payload -Secret $secret
Test-Jwt -jwt $jwt -Secret $secret
```

Read the header and payload from an existing token:
## Documentation

```powershell
Get-JwtHeader -jwt $jwt
Get-JwtPayload -jwt $jwt
```
Documentation is published at [psmodule.io/Jwt](https://psmodule.io/Jwt/).

For more information about each command, use PowerShell help:
Use PowerShell help and command discovery for module details:

```powershell
Get-Command -Module Jwt
Get-Help New-Jwt -Full
Get-Help <CommandName> -Examples
```

## Contributing

Coder or not, you can contribute to the project! We welcome all contributions.

### For Users

If you don't code, you still sit on valuable information that can make this project even better. If you experience that the
product does unexpected things, throw errors or is missing functionality, you can help by submitting bugs and feature requests.
Please see the issues tab on this project and submit a new issue that matches your needs.

### For Developers

If you do code, we'd love to have your contributions. Please read the [Contribution guidelines](CONTRIBUTING.md) for more information.
You can either help by picking up an existing issue or submit a new one if you have an idea for a new feature or improvement.

## Acknowledgements

Here is a list of people and projects that helped this project in some way.
Issues and pull requests are welcome. Please use the repository issue tracker to report bugs, request features, or discuss improvements.
Loading