Skip to content

Commit 894a50e

Browse files
📝 [Docs]: Update README to clarify module's direct bindings to libsodium (#18)
## Description This pull request includes several changes to the `README.md` file for the Sodium PowerShell module. The updates primarily focus on replacing references to the `Sodium.Core` library with `libsodium` and improving the acknowledgements section. * Updated the module description to indicate it provides direct bindings to the `libsodium` cryptographic library instead of `Sodium.Core`. * Removed the reference to the `Sodium.Core` library in the list of external resources relied upon by the module. * Reorganized the acknowledgements section to consolidate the resources that made the module possible, removing specific mentions of `Sodium.Core` and module isolation logic examples. ## Type of change <!-- Use the check-boxes [x] on the options that are relevant. --> - [x] 📖 [Docs] - [ ] 🪲 [Fix] - [ ] 🩹 [Patch] - [ ] ⚠️ [Security fix] - [ ] 🚀 [Feature] - [ ] 🌟 [Breaking change] ## Checklist <!-- Use the check-boxes [x] on the options that are relevant. --> - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas
1 parent bbd9fb2 commit 894a50e

1 file changed

Lines changed: 2 additions & 9 deletions

File tree

README.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Sodium
22

3-
A PowerShell module that provides [`Sodium.Core`](https://github.com/ektrah/libsodium-core) functionality.
3+
A PowerShell module that provides direct bindings to the [`libsodium`](https://github.com/jedisct1/libsodium) cryptographic library.
44

55
This module was initially created to serve the needs of the [GitHub PowerShell module](https://github.com/PSModule/GitHub).
66
GitHub's method for creating or updating [secrets via the REST API](https://docs.github.com/en/rest/guides/encrypting-secrets-for-the-rest-api?apiVersion=2022-11-28#example-encrypting-a-secret-using-c)
@@ -12,7 +12,6 @@ This module relies on the following external resources:
1212

1313
- The [PSModule framework](https://github.com/PSModule) for building, testing, and publishing the module.
1414
- The [libsodium](https://github.com/jedisct1/libsodium) library for cryptographic operations.
15-
- The [Sodium.Core](https://github.com/ektrah/libsodium-core) library, which provides .NET bindings.
1615

1716
## Installation
1817

@@ -99,12 +98,6 @@ You can help by picking up an existing issue or submitting a new one if you have
9998

10099
## Acknowledgements
101100

102-
### Module Isolation Logic
101+
This module would not be possible without the following resources:
103102

104-
- Resolving PowerShell module assembly dependency conflicts | [PowerShell Docs @ Microsoft Learn](https://learn.microsoft.com/en-us/powershell/scripting/dev-cross-plat/resolving-dependency-conflicts?view=powershell-7.4#more-robust-solutions)
105-
- rjmholt/ModuleDependencyIsolationExample [GitHub](https://github.com/rjmholt/ModuleDependencyIsolationExample)
106-
107-
### Libsodium
108-
109-
- **Sodium.Core** | [GitHub](https://github.com/ektrah/libsodium-core)
110103
- **libsodium** | [Docs](https://doc.libsodium.org/) | [GitHub](https://github.com/jedisct1/libsodium)

0 commit comments

Comments
 (0)