Skip to content
This repository has been archived by the owner on Dec 10, 2024. It is now read-only.

Commit

Permalink
Rebranding
Browse files Browse the repository at this point in the history
  • Loading branch information
james-pre committed Mar 22, 2024
1 parent acf992e commit 18ce781
Show file tree
Hide file tree
Showing 9 changed files with 35 additions and 35 deletions.
2 changes: 1 addition & 1 deletion license.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2013-2023 John Vilk and other BrowserFS contributors.
Copyright (c) 2013-2023 John Vilk and other ZenFS contributors.

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
Expand Down
14 changes: 7 additions & 7 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 7 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@browserfs/iso",
"name": "@zenfs/iso",
"version": "0.0.2",
"description": "Zip backend for BrowserFS",
"description": "Iso backend for ZenFS",
"main": "dist/index.js",
"types": "dist",
"keywords": [
Expand All @@ -10,15 +10,15 @@
"storage"
],
"type": "module",
"homepage": "https://github.com/browser-fs/iso",
"homepage": "https://github.com/zen-fs/iso",
"author": "dr-vortex <[email protected]>",
"license": "MIT",
"repository": {
"type": "git",
"url": "git+https://github.com/browser-fs/iso.git"
"url": "git+https://github.com/zen-fs/iso.git"
},
"bugs": {
"url": "https://github.com/browser-fs/iso/issues"
"url": "https://github.com/zen-fs/iso/issues"
},
"engines": {
"node": ">= 18"
Expand All @@ -31,7 +31,7 @@
"format:check": "prettier --check src",
"lint": "eslint src",
"build": "node scripts/build.mjs",
"build:docs": "typedoc --out docs --name BrowserFS src/index.ts",
"build:docs": "typedoc --out docs --name ZenFS src/index.ts",
"prepublishOnly": "npm run build"
},
"devDependencies": {
Expand All @@ -45,6 +45,6 @@
"typescript": "5.2.2"
},
"peerDependencies": {
"@browserfs/core": "^0.3.2"
"@zenfs/core": "^0.3.2"
}
}
16 changes: 8 additions & 8 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,30 @@
# BrowserFS `iso` Backend
# ZenFS `iso` Backend

[BrowserFS](https://github.com/browser-fs/core) backend for `iso` files.
[ZenFS](https://github.com/zen-fs/core) backend for `iso` files.

> [!IMPORTANT]
> Please read the BrowserFS core documentation!
> Please read the ZenFS core documentation!
## Backend

This package adds the `Iso` backend, which allows you to create a _readonly_ file system from a iso file.

For more information, see the [API documentation](https://browser-fs.github.io/iso).
For more information, see the [API documentation](https://zen-fs.github.io/iso).

## Installing

```sh
npm install @browserfs/iso
npm install @zenfs/iso
```

## Usage

> [!NOTE]
> The examples are written in ESM. If you are using CJS, you can `require` the package. If running in a browser you can add a script tag to your HTML pointing to the `browser.min.js` and use BrowserFS Iso via the global `BrowserFS_ISO` object.
> The examples are written in ESM. If you are using CJS, you can `require` the package. If running in a browser you can add a script tag to your HTML pointing to the `browser.min.js` and use ZenFS Iso via the global `ZenFS_ISO` object.
```js
import { configure, fs } from '@browserfs/core';
import { Iso } from '@browserfs/iso';
import { configure, fs } from '@zenfs/core';
import { Iso } from '@zenfs/iso';

const res = await fetch('http://example.com/image.iso');

Expand Down
2 changes: 1 addition & 1 deletion scripts/build.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ const options = parseArgs({
const ctx = await context({
entryPoints: ['src/index.ts'],
target: 'es2020',
globalName: 'BrowserFS_ISO',
globalName: 'ZenFS_ISO',
outfile: 'dist/browser.min.js',
sourcemap: true,
keepNames: true,
Expand Down
2 changes: 1 addition & 1 deletion src/DirectoryRecord.ts
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ export abstract class DirectoryRecord {
if (flags & SLComponentFlags.CURRENT) {
p += './';
} else if (flags & SLComponentFlags.PARENT) {
p += '@browserfs/core/';
p += '@zenfs/core/';
} else if (flags & SLComponentFlags.ROOT) {
p += '/';
} else {
Expand Down
16 changes: 8 additions & 8 deletions src/IsoFS.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
import { ApiError, ErrorCode } from '@browserfs/core/ApiError.js';
import type { Backend } from '@browserfs/core/backends/backend.js';
import type { Cred } from '@browserfs/core/cred.js';
import * as path from '@browserfs/core/emulation/path.js';
import { resolve } from '@browserfs/core/emulation/path.js';
import { FileFlag, NoSyncFile } from '@browserfs/core/file.js';
import { FileSystem, Readonly, Sync, type FileSystemMetadata } from '@browserfs/core/filesystem.js';
import { FileType, Stats } from '@browserfs/core/stats.js';
import { ApiError, ErrorCode } from '@zenfs/core/ApiError.js';
import type { Backend } from '@zenfs/core/backends/backend.js';
import type { Cred } from '@zenfs/core/cred.js';
import * as path from '@zenfs/core/emulation/path.js';
import { resolve } from '@zenfs/core/emulation/path.js';
import { FileFlag, NoSyncFile } from '@zenfs/core/file.js';
import { FileSystem, Readonly, Sync, type FileSystemMetadata } from '@zenfs/core/filesystem.js';
import { FileType, Stats } from '@zenfs/core/stats.js';
import { DirectoryRecord } from './DirectoryRecord.js';
import { PrimaryOrSupplementaryVolumeDescriptor, PrimaryVolumeDescriptor, SupplementaryVolumeDescriptor, VolumeDescriptor, VolumeDescriptorTypeCode } from './VolumeDescriptor.js';
import { PXEntry, TFEntry, TFFlags } from './entries.js';
Expand Down
2 changes: 1 addition & 1 deletion src/VolumeDescriptor.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { ApiError, ErrorCode } from '@browserfs/core/index.js';
import { ApiError, ErrorCode } from '@zenfs/core/index.js';
import { DirectoryRecord, ISODirectoryRecord, JolietDirectoryRecord } from './DirectoryRecord.js';
import { getASCIIString, getDate, getJolietString } from './utils.js';

Expand Down
2 changes: 1 addition & 1 deletion src/utils.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { decode } from '@browserfs/core/utils.js';
import { decode } from '@zenfs/core/utils.js';

export function getASCIIString(data: ArrayBuffer, startIndex: number, length: number) {
const buffer = data.slice(startIndex, startIndex + length);
Expand Down

0 comments on commit 18ce781

Please sign in to comment.