update readme

APP_README.md

@@ -1,98 +0,0 @@
-# XORB & Shard File Viewer
-
-A static web application built with Svelte that allows you to upload and analyze XORB or Shard object files to view their metadata structure.
-
-## Features
-
-- **File Upload**: Drag & drop or click to upload XORB and Shard files
-- **Automatic Detection**: Automatically detects file type based on binary structure
-- **Comprehensive Metadata Display**: Shows detailed information about file contents
-- **Responsive Design**: Works on desktop and mobile devices
-- **Error Handling**: Provides clear error messages for invalid files
-
-## Supported File Types
-
-### 📦 XORB Files
-
-XORB (Xet Orb) files contain collections of compressed chunks with metadata. The viewer displays:
-
-- Chunk count and sizes
-- Compression ratios
-- Hash information
-- Boundary offsets
-- Individual chunk details
-
-### 🗂️ Shard Files
-
-MDB Shard files store file metadata and content-addressable storage information for efficient deduplication. The viewer shows:
-
-- File information entries
-- CAS (Content Addressable Storage) data
-- Lookup tables
-- Timestamps and security keys
-- Header and footer details
-
-## Development
-
-### Prerequisites
-
-- Node.js 18+
-- pnpm (or npm/yarn)
-
-### Setup
-
-```bash
-cd xorb-shard-viewer
-pnpm install
-pnpm run dev
-```
-
-The application will be available at `http://localhost:5173`
-
-### Build for Production
-
-```bash
-pnpm run build
-```
-
-The static files will be generated in the `build` directory.
-
-## File Format Support
-
-The application implements binary parsers for:
-
-- **XORB Format**: Based on the CAS object format with chunk compression and merkle hashing
-- **Shard Format**: MDB shard file format v2 with header, footer, file info, and CAS info sections
-
-## Architecture
-
-- **Frontend**: Svelte + TypeScript
-- **Parsing**: Custom binary parsers for both file formats
-- **Styling**: Component-scoped CSS with responsive design
-- **Type Safety**: Full TypeScript support with detailed type definitions
-
-## Browser Compatibility
-
-Works in all modern browsers that support:
-
-- File API
-- ArrayBuffer/Uint8Array
-- ES2020+ features
-
-## Security
-
-- All file processing happens client-side
-- No data is uploaded to any server
-- Files are processed entirely in the browser's memory
-
-## Contributing
-
-1. Fork the repository
-2. Create a feature branch
-3. Make your changes
-4. Test thoroughly
-5. Submit a pull request
-
-## License
-
-See the parent repository's LICENSE file for licensing information.

README.md

@@ -11,50 +11,89 @@ license: mit
 short_description: Display the contents of a xorb or a shard
 ---
 
-# Svelte + TS + Vite
+# XORB & Shard File Viewer
 
-This template should help get you started developing with Svelte and TypeScript in Vite.
+A static web application built with Svelte that allows you to upload and analyze XORB or Shard object files to view their metadata structure.
 
-## Recommended IDE Setup
+## Features
 
-[VS Code](https://code.visualstudio.com/) + [Svelte](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode).
+- **File Upload**: Drag & drop or click to upload XORB and Shard files
+- **Automatic Detection**: Automatically detects file type based on binary structure
+- **Comprehensive Metadata Display**: Shows detailed information about file contents
+- **Responsive Design**: Works on desktop and mobile devices
+- **Error Handling**: Provides clear error messages for invalid files
 
-## Need an official Svelte framework?
+## Supported File Types
 
-Check out [SvelteKit](https://github.com/sveltejs/kit#readme), which is also powered by Vite. Deploy anywhere with its serverless-first approach and adapt to various platforms, with out of the box support for TypeScript, SCSS, and Less, and easily-added support for mdsvex, GraphQL, PostCSS, Tailwind CSS, and more.
+### 📦 XORB Files
 
-## Technical considerations
+XORB (Xet Orb) files contain collections of compressed chunks with metadata. The viewer displays:
 
-**Why use this over SvelteKit?**
+- Chunk count and sizes
+- Compression ratios
+- Hash information
+- Boundary offsets
+- Individual chunk details
 
-- It brings its own routing solution which might not be preferable for some users.
-- It is first and foremost a framework that just happens to use Vite under the hood, not a Vite app.
+### 🗂️ Shard Files
 
-This template contains as little as possible to get started with Vite + TypeScript + Svelte, while taking into account the developer experience with regards to HMR and intellisense. It demonstrates capabilities on par with the other `create-vite` templates and is a good starting point for beginners dipping their toes into a Vite + Svelte project.
+MDB Shard files store file metadata and content-addressable storage information for efficient deduplication. The viewer shows:
 
-Should you later need the extended capabilities and extensibility provided by SvelteKit, the template has been structured similarly to SvelteKit so that it is easy to migrate.
+- File information entries
+- CAS (Content Addressable Storage) data
+- Lookup tables
+- Timestamps and security keys
+- Header and footer details
 
-**Why `global.d.ts` instead of `compilerOptions.types` inside `jsconfig.json` or `tsconfig.json`?**
+## Development
 
-Setting `compilerOptions.types` shuts out all other types not explicitly listed in the configuration. Using triple-slash references keeps the default TypeScript setting of accepting type information from the entire workspace, while also adding `svelte` and `vite/client` type information.
+### Prerequisites
 
-**Why include `.vscode/extensions.json`?**
+- Node.js 18+
+- pnpm (or npm/yarn)
 
-Other templates indirectly recommend extensions via the README, but this file allows VS Code to prompt the user to install the recommended extension upon opening the project.
+### Setup
 
-**Why enable `allowJs` in the TS template?**
+```bash
+cd xorb-shard-viewer
+pnpm install
+pnpm run dev
+```
 
-While `allowJs: false` would indeed prevent the use of `.js` files in the project, it does not prevent the use of JavaScript syntax in `.svelte` files. In addition, it would force `checkJs: false`, bringing the worst of both worlds: not being able to guarantee the entire codebase is TypeScript, and also having worse typechecking for the existing JavaScript. In addition, there are valid use cases in which a mixed codebase may be relevant.
+The application will be available at `http://localhost:5173`
 
-**Why is HMR not preserving my local component state?**
+### Build for Production
 
-HMR state preservation comes with a number of gotchas! It has been disabled by default in both `svelte-hmr` and `@sveltejs/vite-plugin-svelte` due to its often surprising behavior. You can read the details [here](https://github.com/rixo/svelte-hmr#svelte-hmr).
+```bash
+pnpm run build
+```
 
-If you have state that's important to retain within a component, consider creating an external store which would not be replaced by HMR.
+The static files will be generated in the `build` directory.
 
-```ts
-// store.ts
-// An extremely simple external store
-import { writable } from "svelte/store";
-export default writable(0);
-```
+## File Format Support
+
+The application implements binary parsers for:
+
+- **XORB Format**: Based on the CAS object format with chunk compression and merkle hashing
+- **Shard Format**: MDB shard file format v2 with header, footer, file info, and CAS info sections
+
+## Architecture
+
+- **Frontend**: Svelte + TypeScript
+- **Parsing**: Custom binary parsers for both file formats
+- **Styling**: Component-scoped CSS with responsive design
+- **Type Safety**: Full TypeScript support with detailed type definitions
+
+## Browser Compatibility
+
+Works in all modern browsers that support:
+
+- File API
+- ArrayBuffer/Uint8Array
+- ES2020+ features
+
+## Security
+
+- All file processing happens client-side
+- No data is uploaded to any server
+- Files are processed entirely in the browser's memory