Skip to content

Commit c7d2019

Browse files
committed
readme
1 parent 1f24d8f commit c7d2019

1 file changed

Lines changed: 26 additions & 26 deletions

File tree

README.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,8 @@ cd my-app
6161
pgpm init
6262
cd packages/your-module
6363

64-
# 3. Install a package
65-
pgpm install @pgpm/faker
64+
# 3. Install a package
65+
pgpm install [@pgpm/faker](https://www.npmjs.com/package/@pgpm/faker)
6666

6767
# 4. Deploy everything
6868
pgpm deploy --createdb --database mydb1
@@ -76,8 +76,8 @@ psql -d mydb1 -c "SELECT faker.city('MI');"
7676
# 1. Navigate to your module
7777
cd packages/your-module
7878

79-
# 2. Install a package
80-
pgpm install @pgpm/faker
79+
# 2. Install a package
80+
pgpm install [@pgpm/faker](https://www.npmjs.com/package/@pgpm/faker)
8181

8282
# 3. Deploy all installed modules
8383
pgpm deploy --createdb --database mydb1
@@ -112,38 +112,38 @@ Each module includes its own README with detailed documentation. See individual
112112
## Package Structure
113113

114114
### Data Types
115-
- `@pgpm/types` - Core PostgreSQL data types
116-
- `@pgpm/uuid` - UUID utilities and extensions
117-
- `@pgpm/stamps` - Timestamp utilities and audit trails
118-
- `@pgpm/geotypes` - Geographic data types and spatial functions
115+
- [`@pgpm/types`](https://www.npmjs.com/package/@pgpm/types) - Core PostgreSQL data types
116+
- [`@pgpm/uuid`](https://www.npmjs.com/package/@pgpm/uuid) - UUID utilities and extensions
117+
- [`@pgpm/stamps`](https://www.npmjs.com/package/@pgpm/stamps) - Timestamp utilities and audit trails
118+
- [`@pgpm/geotypes`](https://www.npmjs.com/package/@pgpm/geotypes) - Geographic data types and spatial functions
119119

120120
### Jobs & Background Processing
121-
- `@pgpm/jobs` - Core job system for background tasks
122-
- `@pgpm/database-jobs` - Database-specific job handling
121+
- [`@pgpm/jobs`](https://www.npmjs.com/package/@pgpm/jobs) - Core job system for background tasks
122+
- [`@pgpm/database-jobs`](https://www.npmjs.com/package/@pgpm/database-jobs) - Database-specific job handling
123123

124124
### Meta & Database Introspection
125-
- `@pgpm/db_meta` - Database metadata utilities
126-
- `@pgpm/db_meta_modules` - Module metadata handling
127-
- `@pgpm/db_meta_test` - Testing utilities for metadata
125+
- [`@pgpm/db_meta`](https://www.npmjs.com/package/@pgpm/db_meta) - Database metadata utilities
126+
- [`@pgpm/db_meta_modules`](https://www.npmjs.com/package/@pgpm/db_meta_modules) - Module metadata handling
127+
- [`@pgpm/db_meta_test`](https://www.npmjs.com/package/@pgpm/db_meta_test) - Testing utilities for metadata
128128

129129
### Security & Authentication
130-
- `@pgpm/default-roles` - Default PostgreSQL role definitions
131-
- `@pgpm/defaults` - Security defaults and configurations
132-
- `@pgpm/jwt-claims` - JWT claim handling and validation
133-
- `@pgpm/totp` - Time-based One-Time Password authentication
134-
- `@pgpm/encrypted-secrets` - Encrypted secrets management
135-
- `@pgpm/encrypted-secrets-table` - Table-based encrypted secrets
130+
- [`@pgpm/default-roles`](https://www.npmjs.com/package/@pgpm/default-roles) - Default PostgreSQL role definitions
131+
- [`@pgpm/defaults`](https://www.npmjs.com/package/@pgpm/defaults) - Security defaults and configurations
132+
- [`@pgpm/jwt-claims`](https://www.npmjs.com/package/@pgpm/jwt-claims) - JWT claim handling and validation
133+
- [`@pgpm/totp`](https://www.npmjs.com/package/@pgpm/totp) - Time-based One-Time Password authentication
134+
- [`@pgpm/encrypted-secrets`](https://www.npmjs.com/package/@pgpm/encrypted-secrets) - Encrypted secrets management
135+
- [`@pgpm/encrypted-secrets-table`](https://www.npmjs.com/package/@pgpm/encrypted-secrets-table) - Table-based encrypted secrets
136136

137137
### Utilities
138-
- `@pgpm/utils` - General utility functions
139-
- `@pgpm/verify` - Verification utilities (used by other modules)
140-
- `@pgpm/inflection` - String inflection utilities
141-
- `@pgpm/base32` - Base32 encoding/decoding
142-
- `@pgpm/faker` - Fake data generation for testing
138+
- [`@pgpm/utils`](https://www.npmjs.com/package/@pgpm/utils) - General utility functions
139+
- [`@pgpm/verify`](https://www.npmjs.com/package/@pgpm/verify) - Verification utilities (used by other modules)
140+
- [`@pgpm/inflection`](https://www.npmjs.com/package/@pgpm/inflection) - String inflection utilities
141+
- [`@pgpm/base32`](https://www.npmjs.com/package/@pgpm/base32) - Base32 encoding/decoding
142+
- [`@pgpm/faker`](https://www.npmjs.com/package/@pgpm/faker) - Fake data generation for testing
143143

144144
### Metrics & Analytics
145-
- `@pgpm/measurements` - Performance tracking and analytics
146-
- `@pgpm/achievements` - Achievement system for user progress
145+
- [`@pgpm/measurements`](https://www.npmjs.com/package/@pgpm/measurements) - Performance tracking and analytics
146+
- [`@pgpm/achievements`](https://www.npmjs.com/package/@pgpm/achievements) - Achievement system for user progress
147147

148148
## pgpm Workflow
149149

0 commit comments

Comments
 (0)