Skip to content

Commit 3f0224e

Browse files
committed
feat: update package name to @hiddentao/zip-json
- Change package name from 'zip-json' to '@hiddentao/zip-json' - Update author information to Ramesh Nair <[email protected]> - Add homepage and bugs URLs pointing to GitHub repository - Update npm badge URL to use scoped package name - Update all import statements in README and documentation - Update installation commands in all documentation - CLI command remains 'zip-json' for ease of use - All tests pass and build works correctly
1 parent 67a6e83 commit 3f0224e

File tree

4 files changed

+28
-24
lines changed

4 files changed

+28
-24
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
[![CI](https://github.com/hiddentao/zip-json/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/hiddentao/zip-json/actions/workflows/ci.yml)
88
[![Coverage Status](https://coveralls.io/repos/github/hiddentao/zip-json/badge.svg?branch=main)](https://coveralls.io/github/hiddentao/zip-json?branch=main)
9-
[![npm version](https://badge.fury.io/js/zip-json.svg)](https://badge.fury.io/js/zip-json)
9+
[![npm version](https://badge.fury.io/js/%40hiddentao%2Fzip-json.svg)](https://badge.fury.io/js/%40hiddentao%2Fzip-json)
1010
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
1111
[![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue.svg)](https://www.typescriptlang.org/)
1212

@@ -42,19 +42,19 @@ Perfect for bundling assets, creating portable backups, or embedding resources d
4242

4343
```bash
4444
# Using Bun (recommended)
45-
bun add zip-json
45+
bun add @hiddentao/zip-json
4646

4747
# Using npm
48-
npm install zip-json
48+
npm install @hiddentao/zip-json
4949

5050
# Global CLI installation
51-
bun add -g zip-json
51+
bun add -g @hiddentao/zip-json
5252
```
5353

5454
### Basic Usage
5555

5656
```typescript
57-
import { zip, unzip, list } from 'zip-json'
57+
import { zip, unzip, list } from '@hiddentao/zip-json'
5858

5959
// Create an archive
6060
const archive = await zip(['src/**/*.ts', '*.md'], {
@@ -99,7 +99,7 @@ zip-json zip "src/**/*" -o backup.json --quiet
9999
### Basic File Archiving
100100

101101
```typescript
102-
import { zip, unzip } from 'zip-json'
102+
import { zip, unzip } from '@hiddentao/zip-json'
103103

104104
// Archive TypeScript source files
105105
const sourceArchive = await zip(['src/**/*.ts', 'types/**/*.d.ts'], {
@@ -121,7 +121,7 @@ await unzip(archive, {
121121
### Progress Tracking
122122

123123
```typescript
124-
import { zip } from 'zip-json'
124+
import { zip } from '@hiddentao/zip-json'
125125

126126
const archive = await zip(['**/*'], {
127127
baseDir: './large-project',
@@ -140,7 +140,7 @@ const archive = await zip(['**/*'], {
140140
### Error Handling
141141

142142
```typescript
143-
import { zip, FileNotFoundError, PermissionError } from 'zip-json'
143+
import { zip, FileNotFoundError, PermissionError } from '@hiddentao/zip-json'
144144

145145
try {
146146
const archive = await zip(['src/**/*.ts'])
@@ -174,7 +174,7 @@ await unzip(receivedArchive, { outputDir: './deployed' })
174174
### Selective File Operations
175175

176176
```typescript
177-
import { list, unzip } from 'zip-json'
177+
import { list, unzip } from '@hiddentao/zip-json'
178178

179179
// Load archive and inspect contents
180180
const archive = await Bun.file('backup.json').json()

docs/api.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@ This document provides comprehensive documentation for the zip-json API.
1414
## Installation
1515

1616
```bash
17-
bun add zip-json
17+
bun add @hiddentao/zip-json
1818
# or
19-
npm install zip-json
19+
npm install @hiddentao/zip-json
2020
```
2121

2222
## Quick Start
2323

2424
```typescript
25-
import { zip, unzip, list } from 'zip-json'
25+
import { zip, unzip, list } from '@hiddentao/zip-json'
2626

2727
// Zip files to JSON
2828
const archive = await zip(['src/**/*.ts'], { baseDir: 'project' })
@@ -229,7 +229,7 @@ Thrown when compression/decompression fails.
229229

230230
**Example:**
231231
```typescript
232-
import { zip, FileNotFoundError, PermissionError } from 'zip-json'
232+
import { zip, FileNotFoundError, PermissionError } from '@hiddentao/zip-json'
233233

234234
try {
235235
const archive = await zip(['src/**/*.ts'])
@@ -249,7 +249,7 @@ try {
249249
### Basic File Archiving
250250

251251
```typescript
252-
import { zip, unzip } from 'zip-json'
252+
import { zip, unzip } from '@hiddentao/zip-json'
253253

254254
// Create archive from TypeScript files
255255
const archive = await zip(['src/**/*.ts', 'types/**/*.d.ts'], {
@@ -272,7 +272,7 @@ console.log(`Restored ${restored.length} files`)
272272
### Progress Tracking
273273

274274
```typescript
275-
import { zip } from 'zip-json'
275+
import { zip } from '@hiddentao/zip-json'
276276

277277
const archive = await zip(['**/*'], {
278278
baseDir: './large-project',
@@ -287,7 +287,7 @@ const archive = await zip(['**/*'], {
287287
### Selective Extraction
288288

289289
```typescript
290-
import { list, unzip } from 'zip-json'
290+
import { list, unzip } from '@hiddentao/zip-json'
291291

292292
// Load archive
293293
const archive = JSON.parse(await readFile('backup.json', 'utf8'))
@@ -314,7 +314,7 @@ await unzip(filteredArchive, { outputDir: './js-only' })
314314
### Streaming Large Archives
315315

316316
```typescript
317-
import { zip } from 'zip-json'
317+
import { zip } from '@hiddentao/zip-json'
318318

319319
// For very large archives, use progress callbacks to provide feedback
320320
const archive = await zip(['**/*'], {

docs/cli.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ This document provides comprehensive documentation for the zip-json command-line
1515

1616
```bash
1717
# Install globally
18-
bun add -g zip-json
18+
bun add -g @hiddentao/zip-json
1919
# or
20-
npm install -g zip-json
20+
npm install -g @hiddentao/zip-json
2121

2222
# Or run directly with bunx/npx
23-
bunx zip-json --help
24-
npx zip-json --help
23+
bunx @hiddentao/zip-json --help
24+
npx @hiddentao/zip-json --help
2525
```
2626

2727
## Quick Start

package.json

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "zip-json",
2+
"name": "@hiddentao/zip-json",
33
"version": "1.0.0",
44
"description": "Zip files and folders into a JSON format for bundling and runtime extraction",
55
"keywords": [
@@ -10,11 +10,15 @@
1010
"archive",
1111
"bun"
1212
],
13-
"author": "Your Name",
13+
"author": "Ramesh Nair <[email protected]>",
1414
"license": "MIT",
1515
"repository": {
1616
"type": "git",
17-
"url": "https://github.com/yourusername/zip-json.git"
17+
"url": "https://github.com/hiddentao/zip-json.git"
18+
},
19+
"homepage": "https://github.com/hiddentao/zip-json",
20+
"bugs": {
21+
"url": "https://github.com/hiddentao/zip-json/issues"
1822
},
1923
"type": "module",
2024
"main": "./dist/cjs/index.js",

0 commit comments

Comments
 (0)