Skip to content

Commit a71a4fa

Browse files
committed
SBOM added to README, v2.3.1
1 parent 1d2ae8d commit a71a4fa

File tree

3 files changed

+350
-294
lines changed

3 files changed

+350
-294
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@
88

99
> Easy and secure configuration management.
1010
11-
Manage JSON based configurations with encrypted secrets and optional HMAC validation to ensure data integrity.
11+
Manage JSON based configurations with AES encrypted secrets and optional HMAC validation to ensure data integrity.
1212

13-
Works with CommonJS and ESM/ECMAScript.
13+
Works with CommonJS and ESM/ECMAScript. Ships with a [SBOM](#SBOM) to meet regulatory requirements.
1414

1515
If you are upgrading from an older version prior to 2.x please read this [important note](#upgrading-from-versions-prior-to-2x).
1616

1717
## Usage
1818

19-
1. Encrypt sensitive data in your JSON configuration file. Most easy way to do this is using the [secure-config-tool](https://www.npmjs.com/package/@tsmx/secure-config-tool).
19+
1. Encrypt sensitive data in your JSON configuration file. Easiest way to do this is using the [secure-config-tool](https://www.npmjs.com/package/@tsmx/secure-config-tool).
2020
For more details please see [generating an encrypted configuration](#generating-an-encrypted-configuration) and [naming conventions](#naming-conventions).
2121
```json
2222
{
@@ -323,6 +323,10 @@ const conf = require('@tsmx/secure-config')();
323323
// use conf as you did before...
324324
```
325325
326+
## SBOM
327+
328+
This package ships with a CycloneDX software bill of materials (SBOM) v1.6 in JSON format as required by some regulatory like the BSI TR-03183. The file is located under the `sbom` folder.
329+
326330
## Changelog
327331
328332
### 2.1.0
@@ -334,6 +338,9 @@ const conf = require('@tsmx/secure-config')();
334338
### 2.3.0
335339
- Support for custom configuration file path with new option [directory](#directory) added.
336340
341+
### 2.3.1
342+
- [SBOM](#SBOM) added to shipped files
343+
337344
## Test
338345
339346
```

0 commit comments

Comments
 (0)