Skip to content

Commit 8a61f29

Browse files
authored
minor fixes
1 parent 354b657 commit 8a61f29

1 file changed

Lines changed: 6 additions & 8 deletions

File tree

‎README.md‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,8 @@ you keep watching the ones you already use as dependencies.
4040

4141
## What's provided
4242

43-
For this first iteration, HealthyCode focus is on npm packages. We will extend
44-
support to other ecosystems, and we designed the scording model to be specific
45-
to one open source packaging ecosystem.
43+
For this first iteration, we designed HealthyCode's scoring model to be specific
44+
to one open source packaging ecosystem, npm. We will extend future support to other ecosystems.
4645

4746
Given a PURL (Package-URL) for a package, HealthyCode's API returns:
4847

@@ -141,13 +140,13 @@ configuration or security posture of a project. For those, see:
141140
- [VulnerableCode](https://github.com/aboutcode-org/vulnerablecode) for vulnerability lookup
142141
- [ScanCode.io](https://github.com/aboutcode-org/scancode.io) to orchestrate scans including health scans
143142
- [ScanCode Toolkit](https://github.com/aboutcode-org/scancode-toolkit) for origin, license, copyright, and dependencies
144-
- [PurlDB](https://github.com/aboutcode-org/purldb) that also hosts the health/API endpoint.
143+
- [PurlDB](https://github.com/aboutcode-org/purldb) also hosts the health/API endpoint.
145144
- [ClearlyDefined](https://https://github.com/clearlydefined/) that pre-scans and curates open source packages.
146145

147146

148147
## Getting started
149148

150-
You access health data by Package-URL (PURL) using the [PurlDB](https://github.com/aboutcode-org/purldb)/health API.
149+
You access health data by Package-URL (PURL) using the PurlDB/health API.
151150
This is accessible at https://health.purldb.io/api/health for demonstration.
152151
For instance, check https://health.purldb.io/api/health/?purl=pkg:npm/semver or https://health.purldb.io/api/health/?purl=pkg:npm/lodash .
153152

@@ -214,7 +213,7 @@ For example:
214213
- Metrics: Pony factor (CHAOSS Contributor Absence Factor aka. "Bus Factor" ),
215214
e.g., top author's share of commits over the last 12 months.
216215

217-
## (npm-health) scoring model
216+
## Scoring model for health
218217

219218
The model was trained on about 1,150 popular npm packages drawn from Census II,
220219
Census III, and deps.dev. As open source experts, we reviewed about 200 of these
@@ -295,8 +294,7 @@ chains. Exposing the /health endpoint in PurlDB also puts a package's health
295294
data next to its license and origin data collected in PurlDB from ScanCode,
296295
eventually delivering better visibility into the packages from multiple angles.
297296

298-
HealthyCode is developed by the AboutCode and GrimoireLab community and
299-
community contributors like you!
297+
HealthyCode is developed by the AboutCode and GrimoireLab community and contributors like you!
300298

301299
## Contributing
302300

0 commit comments

Comments
 (0)