Skip to content

Commit 7e9043a

Browse files
Clean up README by removing redundant Example and CommonJS Usage sections
- Remove 'Example' section with basic TypeScript examples - Remove 'CommonJS Usage' section with require() examples - Keep comprehensive 'Usage' section with full API documentation - Update Table of Contents to reflect streamlined structure - Consolidates documentation for cleaner, less redundant README Co-Authored-By: Dan Lynch <[email protected]>
1 parent 7bc41df commit 7e9043a

File tree

1 file changed

+6
-29
lines changed

1 file changed

+6
-29
lines changed

README.md

Lines changed: 6 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,12 @@ A WASM-based PostgreSQL query parser that provides the same functionality as the
2323
## Table of Contents
2424

2525
1. [Installation](#installation)
26-
2. [Example](#example)
27-
3. [Usage](#usage)
28-
4. [Build Instructions](#build-instructions)
29-
5. [Testing](#testing)
30-
6. [Versions](#versions)
31-
7. [Related Projects](#related-projects)
32-
8. [Credit](#credit)
26+
2. [Usage](#usage)
27+
3. [Build Instructions](#build-instructions)
28+
4. [Testing](#testing)
29+
5. [Versions](#versions)
30+
6. [Related Projects](#related-projects)
31+
7. [Credit](#credit)
3332

3433

3534
## Installation
@@ -38,28 +37,6 @@ A WASM-based PostgreSQL query parser that provides the same functionality as the
3837
npm install libpg-query
3938
```
4039

41-
## Example
42-
43-
```typescript
44-
import { parseQuery, parseQuerySync } from 'libpg-query';
45-
46-
// Async usage (recommended)
47-
const result = await parseQuery('SELECT * FROM users WHERE id = $1');
48-
console.log(result);
49-
50-
// Sync usage
51-
const syncResult = parseQuerySync('SELECT * FROM users WHERE id = $1');
52-
console.log(syncResult);
53-
```
54-
55-
### CommonJS Usage
56-
57-
```javascript
58-
const { parseQuery, parseQuerySync } = require('libpg-query');
59-
60-
parseQuery('SELECT * FROM users WHERE id = $1').then(console.log);
61-
```
62-
6340
## Usage
6441

6542
### `parseQuery(sql: string): Promise<ParseResult[]>`

0 commit comments

Comments
 (0)