Skip to content
This repository was archived by the owner on Aug 14, 2024. It is now read-only.

Commit 32a613d

Browse files
committed
refactor(README.md):Badge style update
1 parent 6deaaa9 commit 32a613d

File tree

1 file changed

+19
-11
lines changed

1 file changed

+19
-11
lines changed

README.md

+19-11
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
# rc
2-
![version](https://img.shields.io/badge/dynamic/json.svg?url=https://raw.githubusercontent.com/NodeSecure/rc/master/package.json&query=$.version&label=Version)
3-
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/NodeSecure/rc/commit-activity)
4-
[![mit](https://img.shields.io/github/license/Naereen/StrapDown.js.svg)](https://github.com/NodeSecure/rc/blob/master/LICENSE)
2+
3+
![version](https://img.shields.io/badge/dynamic/json.svg?style=for-the-badge&url=https://raw.githubusercontent.com/NodeSecure/rc/master/package.json&query=$.version&label=Version)
4+
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg?style=for-the-badge)](https://github.com/NodeSecure/rc/commit-activity)
5+
[![mit](https://img.shields.io/github/license/Naereen/StrapDown.js.svg?style=for-the-badge)](https://github.com/NodeSecure/rc/blob/master/LICENSE)
56
[![OpenSSF
6-
Scorecard](https://api.securityscorecards.dev/projects/github.com/NodeSecure/rc/badge)](https://api.securityscorecards.dev/projects/github.com/NodeSecure/rc)
7-
![build](https://img.shields.io/github/actions/workflow/status/NodeSecure/rc/main.yml)
7+
Scorecard](https://api.securityscorecards.dev/projects/github.com/NodeSecure/rc/badge?style=for-the-badge)](https://api.securityscorecards.dev/projects/github.com/NodeSecure/rc)
8+
![build](https://img.shields.io/github/actions/workflow/status/NodeSecure/rc/main.yml?style=for-the-badge)
89

910
NodeSecure runtime configuration.
1011

1112
## Requirements
13+
1214
- [Node.js](https://nodejs.org/en/) v16 or higher
1315

1416
## Getting Started
@@ -35,18 +37,17 @@ console.log(configurationPayload);
3537
```
3638

3739
Write:
40+
3841
```ts
3942
import assert from "node:assert/strict";
4043
import * as RC from "@nodesecure/rc";
4144

4245
const writeOpts: RC.writeOptions = {
4346
payload: { version: "2.0.0" },
44-
partialUpdate: true
47+
partialUpdate: true,
4548
};
4649

47-
const result = (
48-
await RC.write(void 0, writeOpts)
49-
).unwrap();
50+
const result = (await RC.write(void 0, writeOpts)).unwrap();
5051
assert.strictEqual(result, void 0);
5152
```
5253

@@ -74,7 +75,10 @@ interface createReadOptions {
7475
createMode?: RCGenerationMode | RCGenerationMode[];
7576
}
7677

77-
export type readOptions = RequireAtLeastOne<createReadOptions, "createIfDoesNotExist" | "createMode">;
78+
export type readOptions = RequireAtLeastOne<
79+
createReadOptions,
80+
"createIfDoesNotExist" | "createMode"
81+
>;
7882
```
7983

8084
The `createIfDoesNotExist` argument can be ignored if `createMode` is provided.
@@ -146,14 +150,15 @@ Note that you can combine several modes:
146150
```ts
147151
import * as RC from "@nodesecure/rc";
148152

149-
await RC.read(void 0, { createMode: ["ci", "report"] })
153+
await RC.read(void 0, { createMode: ["ci", "report"] });
150154
```
151155

152156
## JSON Schema
153157

154158
The runtime configuration is validated with a JSON Schema: `./src/schema/nodesecurerc.json`.
155159

156160
It can be retrieved by API if required:
161+
157162
```ts
158163
import * as RC from "@nodesecure/rc";
159164

@@ -163,7 +168,9 @@ console.log(RC.JSONSchema);
163168
## Contributors ✨
164169

165170
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
171+
166172
[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)
173+
167174
<!-- ALL-CONTRIBUTORS-BADGE:END -->
168175

169176
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
@@ -185,4 +192,5 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
185192
<!-- ALL-CONTRIBUTORS-LIST:END -->
186193

187194
## License
195+
188196
MIT

0 commit comments

Comments
 (0)