diff --git a/README.md b/README.md index f3886f8..723f547 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,64 @@ # PackwizJS -A simple JavaScript module to parse the contents of Packwiz index files. \ No newline at end of file +A simple JavaScript module to parse the contents of Packwiz index files. + +## Installation + +TODO + +## Usage + +See the [documentation](./docs) for more information. + +### Basic Example + +```ts +> import { parsePackwiz } from "packwizjs"; +> const packwizFile = parsePackwiz("./packwiz/pack.toml") +Packwiz { + location: Resource { path: './packwiz/pack.toml' }, + index: { // The index file is automatically parsed alongside the pack.toml file + location: Resource { path: 'packwiz/index.toml' }, + hash: '6ce48b376540c840b9c2c1eaedbdf64f3b0e1203888ea644fc5d8fff66377c18', + hashFormat: 'sha256', + files: [ + [IndexFileEntry], + [IndexFileEntry], + [IndexFileEntry], + [IndexFileEntry] + ] + }, + name: 'PackwizJS Testing Pack', + packFormat: 'packwiz:1.1.0', + authors: [ 'cswimr', 'GalacticFactory' ], + description: 'PackwizJS Testing Pack', + version: '1.0.0', + versions: { + minecraft: '1.21.4', + fabric: '0.16.10', + forge: undefined, + neoforge: undefined, + quilt: undefined, + liteloader: undefined + } +} +> packwizFile.index.files[2].parse() +{ + name: 'Fabric API', + filename: 'fabric-api-0.115.1+1.21.4.jar', + side: 'both', + provider: ModrinthProvider { + hash: 'd5e9f87679b5edc9786e651fc481f8861a9cf53ed381890a1cb5e129222d6c5fa99f06045007f8e1fba02da686cdb6db2d99b334a1d23881cb56dfa199932eea', + hashFormat: 'sha512', + url: Resource { + path: 'https://cdn.modrinth.com/data/P7dR8mSH/versions/UnrycCWP/fabric-api-0.115.1%2B1.21.4.jar' + }, + modId: 'P7dR8mSH', + versionId: 'UnrycCWP' + }, + isOptional: false, + isDefault: true, + description: undefined +} +``` +