Skip to content
This repository was archived by the owner on Jun 16, 2026. It is now read-only.

Commit aa9e950

Browse files
committed
docs(readme): 更新部分说明
1 parent 93baedb commit aa9e950

1 file changed

Lines changed: 51 additions & 40 deletions

File tree

README.md

Lines changed: 51 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# mrpack.ts
1+
# @nexora-studios/mrpack.ts
22

33
A TypeScript library for handling mrpack files (Modrinth mod packs) with ESM support.
44

@@ -18,60 +18,28 @@ A TypeScript library for handling mrpack files (Modrinth mod packs) with ESM sup
1818

1919
```bash
2020
# Using npm
21-
npm install mrpack.ts
21+
npm install @nexora-studios/mrpack.ts
2222

2323
# Using pnpm
24-
pnpm add mrpack.ts
24+
pnpm add @nexora-studios/mrpack.ts
2525

2626
# Using yarn
27-
yarn add mrpack.ts
27+
yarn add @nexora-studios/mrpack.ts
2828
```
2929

3030
## Dependencies
3131

3232
- [jszip](https://www.npmjs.com/package/jszip) - For creating ZIP files
33-
- [@iarna/toml](https://www.npmjs.com/package/@iarna/toml) - For handling TOML files (peer dependency)
33+
- [@iarna/toml](https://www.npmjs.com/package/@iarna/toml) - For handling TOML files (peer dependency, optional)
3434

35-
## Scripts
36-
37-
```bash
38-
# Build the project
39-
pnpm run build
40-
41-
# Run tests
42-
pnpm test
43-
44-
# Watch mode for development
45-
pnpm run dev
46-
```
47-
48-
## Project Structure
49-
50-
```
51-
├── src/
52-
│ ├── components/ # Reusable components
53-
│ │ ├── IndexJson.ts # Mod pack metadata handling
54-
│ │ ├── IndexJsonFile.ts # File entry in mod pack index
55-
│ │ ├── Override.ts # Override file handling
56-
│ │ └── index.ts # Component exports
57-
│ ├── lib/ # Core library functionality
58-
│ │ └── mrpack/ # mrpack-specific code
59-
│ ├── types/ # Type definitions
60-
│ └── index.ts # Main entry point
61-
├── dist/ # Compiled output
62-
├── package.json # Project configuration
63-
├── tsconfig.json # TypeScript configuration
64-
├── jest.config.js # Jest configuration
65-
├── .npmrc # pnpm configuration
66-
└── .gitignore # Files to ignore in Git
67-
```
35+
---
6836

6937
## Usage
7038

7139
### Basic Example
7240

7341
```typescript
74-
import { MrpackBuilder, IndexJson, IndexJsonFile, Override } from 'mrpack.ts';
42+
import { MrpackBuilder, IndexJson, IndexJsonFile, Override } from '@nexora-studios/mrpack.ts';
7543

7644
// Create index metadata
7745
const indexJson = new IndexJson(
@@ -142,13 +110,56 @@ builder.addOverride(override);
142110
const buffer = await builder.build();
143111
```
144112
113+
---
114+
115+
# Development Guide
116+
117+
## Scripts
118+
119+
```bash
120+
# Build the project
121+
pnpm run build
122+
123+
# Run tests
124+
pnpm test
125+
126+
# Watch mode for development
127+
pnpm run dev
128+
```
129+
130+
## Project Structure
131+
132+
```
133+
├── src/
134+
│ ├── components/ # Reusable components
135+
│ │ ├── IndexJson.ts # Mod pack metadata handling
136+
│ │ ├── IndexJsonFile.ts # File entry in mod pack index
137+
│ │ ├── Override.ts # Override file handling
138+
│ │ └── index.ts # Component exports
139+
│ ├── lib/ # Core library functionality
140+
│ │ ├── managers/ # Component managers
141+
│ │ ├── package/ # Package system
142+
│ │ └── mrpack/ # mrpack-specific code
143+
│ ├── types/ # Type definitions
144+
│ └── index.ts # Main entry point
145+
├── tests/ # Test files
146+
├── dist/ # Compiled output
147+
├── package.json # Project configuration
148+
├── tsconfig.json # TypeScript configuration
149+
├── jest.config.js # Jest configuration
150+
├── .npmrc # pnpm configuration
151+
└── .gitignore # Files to ignore in Git
152+
```
153+
154+
---
155+
145156
## TypeScript Support
146157
147158
This library is written in TypeScript and includes type definitions.
148159
149160
## License
150161
151-
AGPL-3.0-only
162+
Apache-2.0
152163
153164
## Author
154165

0 commit comments

Comments
 (0)