Skip to content

Commit 5bbc5ad

Browse files
committed
[scorecard] update README
1 parent 57440eb commit 5bbc5ad

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

β€Žscorecard/README.md

+13-2
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,25 @@
55

66
Calculates the [scorecard](https://github.com/ossf/scorecard) for a given repository.
77

8-
## Usage
8+
## πŸš€ Usage
99

1010
```sh
1111
dagger -m github.com/tsirysndr/daggerverse/scorecard call calc --repo <repository>
1212
```
1313

14-
## Example
14+
## πŸ§‘β€πŸ”¬ Example
1515

1616
```sh
1717
dagger -m github.com/tsirysndr/daggerverse/scorecard call calc --repo github.com/ossf-tests/scorecard-check-branch-protection-e2e
1818
```
19+
20+
## πŸ§‘β€πŸ’» Programmatic usage
21+
22+
```typescript
23+
import { calc } from 'jsr:@daggerverse/scorecard';
24+
25+
await calc(
26+
".",
27+
"github.com/ossf-tests/scorecard-check-branch-protection-e2e"
28+
);
29+
```

β€Žscorecard/deno.json

+3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
{
2+
"name": "@daggerverse/scorecard",
3+
"version": "0.1.0",
4+
"exports": "./mod.ts",
25
"importMap": "import_map.json",
36
"tasks": {
47
"esm:add": "deno run -A https://esm.sh/v128 add",

0 commit comments

Comments
Β (0)