Skip to content

Commit 861ae68

Browse files
committed
Simplify documentation tone and remove marketing language
1 parent c4aa051 commit 861ae68

File tree

2 files changed

+14
-20
lines changed

2 files changed

+14
-20
lines changed

README.md

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,15 @@
66
[![Follow @SocketSecurity](https://img.shields.io/twitter/follow/SocketSecurity?style=social)](https://twitter.com/SocketSecurity)
77
[![Follow @socket.dev on Bluesky](https://img.shields.io/badge/[email protected]?style=social&logo=bluesky)](https://bsky.app/profile/socket.dev)
88

9-
TypeScript-first Package URL (purl) parser and builder. **Drop-in replacement** for [`packageurl-js`](https://socket.dev/npm/package/packageurl-js) with better types and zero dependencies.
10-
11-
**Why use this?**
12-
- 🎯 **TypeScript-first**: Full type safety and IntelliSense
13-
- 📦 **Zero dependencies**: No supply chain bloat
14-
-**Spec compliant**: Implements [Package URL specification](https://github.com/package-url/purl-spec)
15-
- 🔨 **Builder API**: Fluent, ecosystem-specific builders
9+
TypeScript Package URL (purl) parser and builder. Drop-in replacement for [`packageurl-js`](https://socket.dev/npm/package/packageurl-js) with full type safety, zero dependencies, and spec compliance with the [Package URL specification](https://github.com/package-url/purl-spec).
1610

1711
## Installation
1812

1913
```sh
2014
pnpm install @socketregistry/packageurl-js
2115
```
2216

23-
**Package override** (recommended for drop-in replacement):
17+
**Drop-in replacement** via package override:
2418
```json
2519
{
2620
"pnpm": {
@@ -35,7 +29,7 @@ pnpm install @socketregistry/packageurl-js
3529

3630
## Usage
3731

38-
**Parse existing purls:**
32+
**Parse purls:**
3933
```javascript
4034
import { PackageURL } from '@socketregistry/packageurl-js'
4135

@@ -44,7 +38,7 @@ console.log(purl.name) // 'lodash'
4438
console.log(purl.version) // '4.17.21'
4539
```
4640

47-
**Build new purls (recommended):**
41+
**Build purls:**
4842
```javascript
4943
import { PackageURLBuilder } from '@socketregistry/packageurl-js'
5044

@@ -106,11 +100,11 @@ function processPurl(type: EcosystemString) {
106100

107101
## Documentation
108102

109-
**[Complete API Reference](./docs/API.md)** - Full API documentation with detailed examples
103+
**[→ API Reference](./docs/API.md)** - Complete API documentation
110104

111-
**[Usage Examples](./docs/EXAMPLES.md)** - Practical examples for common use cases
105+
**[→ Examples](./docs/EXAMPLES.md)** - Common use cases
112106

113-
**[Builder Pattern Guide](./docs/BUILDERS.md)** - Comprehensive builder pattern documentation
107+
**[Builders](./docs/BUILDERS.md)** - Builder pattern guide
114108

115109
## Development
116110

docs/API.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# API Reference
22

3-
Complete API reference for `@socketregistry/packageurl-js`. All parsing and validation methods throw errors on invalid input.
3+
API reference for `@socketregistry/packageurl-js`. All parsing and validation methods throw on invalid input.
44

55
## PackageURL
66

@@ -20,7 +20,7 @@ Create a new PackageURL instance with validation and normalization.
2020
- `qualifiers` - Additional qualifiers object (optional)
2121
- `subpath` - Subpath within package (optional)
2222

23-
**Throws:** Error if validation fails
23+
**Throws:** On validation failure
2424

2525
<details>
2626
<summary>Show example</summary>
@@ -74,7 +74,7 @@ Parse a purl string into a PackageURL instance.
7474

7575
**Returns:** PackageURL instance
7676

77-
**Throws:** Error if string is invalid
77+
**Throws:** On invalid string
7878

7979
<details>
8080
<summary>Show example</summary>
@@ -112,7 +112,7 @@ Create a PackageURL from a JSON string representation.
112112

113113
**Returns:** PackageURL instance
114114

115-
**Throws:** Error if JSON is invalid
115+
**Throws:** On invalid JSON
116116

117117
<details>
118118
<summary>Show example</summary>
@@ -141,7 +141,7 @@ Create a PackageURL from a plain object.
141141

142142
**Returns:** PackageURL instance
143143

144-
**Throws:** Error if object structure is invalid
144+
**Throws:** On invalid object structure
145145

146146
<details>
147147
<summary>Show example</summary>
@@ -172,7 +172,7 @@ Parse a purl string into an array of components.
172172

173173
**Returns:** Array of [type, namespace, name, version, qualifiers, subpath]
174174

175-
**Throws:** Error if parsing fails
175+
**Throws:** On parse failure
176176

177177
<details>
178178
<summary>Show example</summary>
@@ -657,7 +657,7 @@ Construct and return the final PackageURL instance.
657657

658658
**Returns:** PackageURL instance
659659

660-
**Throws:** Error if configuration is invalid
660+
**Throws:** On invalid configuration
661661

662662
<details>
663663
<summary>Show example</summary>

0 commit comments

Comments
 (0)