🩹 [Patch]: Update README to clarify Context data storage and encryption details#89
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the README to better explain how the Context concept works for secure data storage, details the Set-Context/JSON/encryption flow, and updates the Sodium module links.
- Clarified the Context lifecycle, ID usage, and SecureString handling
- Added step-by-step examples for Set-Context, JSON conversion, encryption, and metadata
- Updated all references to the Sodium module repository
Comments suppressed due to low confidence (1)
README.md:89
- [nitpick] Clarify that the ID is used for both storing and retrieving contexts; consider wording like 'stored and accessed using the ID
GitHub.'
as part of the loading section in the module code. The module configuration is accessed using the ID `GitHub`.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…encryption details
Marius Storhaug (MariusStorhaug)
temporarily deployed
to
github-pages
GitHub Actions
Inactive
|
Module Context - 7.0.6 published to the PowerShell Gallery. |
|
GitHub release for Context v7.0.6 has been created. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This pull request updates the
README.mdfile to clarify the functionality of theContextconcept and improve the documentation for storing and managing data securely in PowerShell modules. It also updates links to theSodiummodule repository.Documentation Improvements:
Contextconcept, emphasizing its role in securely persisting user and module data, and clarified howSecureStringvalues are handled during storage and retrieval.Set-Contextfunction, including how data is converted to JSON, encrypted, and stored to disk, with examples of the file structure and metadata.ContextVaultusing unique IDs.Type of change
Checklist