hypexr
diff --git a/‎README.md‎
Lines changed: 74 additions & 8 deletions b/‎README.md‎
Lines changed: 74 additions & 8 deletions
diff --git a/‎docs/example-files.js‎
Lines changed: 11 additions & 5 deletions b/‎docs/example-files.js‎
Lines changed: 11 additions & 5 deletions
@@ -11,32 +11,98 @@ A browser-based Unix/Linux command emulator with vi editor support.
 - Tab completion
 - Command history
 - Pipe and redirection support
+- Wildcard expansion (`*` and `?`)
 - Customizable filesystem
 - Custom command support
 
 ## Installation
 
+### From npm
+
+```bash
+npm install unix-shell-js
+```
+
 ### Local Development
 
 If you're working locally and want to use this library in another project:
 
 ```bash
 cd ../unix-shell-js
+npm install
+npm run build
 npm link
 
 cd ../your-project
 npm link unix-shell-js
 ```
 
-### From npm (when published)
+## Development
 
-```bash
-npm install unix-shell-js
-```
+This library is written in TypeScript and compiled to JavaScript.
+
+### Build Commands
+
+- `npm run build` - Compile TypeScript to JavaScript (outputs to `dist/`) and copy to demo
+- `npm run copy-to-demo` - Copy built files to `docs/` directory for GitHub Pages demo
+- `npm run watch` - Watch mode for development (auto-recompiles on changes)
+- `npm run prepublishOnly` - Automatically runs before publishing to npm
+
+### Testing
+
+- `npm test` - Run all tests
+- `npm run test:watch` - Run tests in watch mode
+- `npm run test:coverage` - Run tests with coverage report
+
+The project includes comprehensive test suites covering:
+- Core shell functionality (commands, navigation, environment)
+- File system operations (create, read, delete files/directories)
+- File redirection and piping
+- Custom command support
+- Tab completion
+- User switching (su, sudo, exit)
+- localStorage persistence
+
+### Project Structure
+
+- `src/` - TypeScript source files
+  - `index.ts` - Main Unix Shell implementation
+  - `vi-editor.ts` - Vi/Vim editor
+  - `example-files.ts` - Example filesystem generator
+- `dist/` - Compiled JavaScript files (generated by TypeScript compiler)
+  - Includes `.js`, `.d.ts` (type definitions), and `.map` (source maps) files
 
 ## Usage
 
-### Basic Setup
+### TypeScript
+
+The library is written in TypeScript and includes full type definitions:
+
+```typescript
+import { UnixShell } from 'unix-shell-js';
+import { createExampleFiles } from 'unix-shell-js/dist/example-files';
+
+const shell = new UnixShell({
+    username: 'user',
+    fileSystem: createExampleFiles('user'),
+    persistence: {
+        enabled: true,
+        prefix: 'myapp'
+    }
+});
+
+const output: string = shell.execute('ls -la');
+console.log(output);
+```
+
+**Type definitions included:**
+- `UnixShellOptions` - Constructor options
+- `FileSystem` - Filesystem structure types
+- `PersistenceOptions` - Persistence configuration
+- `CommandHandler` - Custom command function signature
+- `CompletionResult` - Tab completion result type
+
+### JavaScript (Browser)
 
 Include the library files in your HTML:
 
@@ -47,9 +113,9 @@ Include the library files in your HTML:
     <title>Terminal</title>
 </head>
 <body>
-    <script src="node_modules/unix-shell-js/index.js"></script>
-    <script src="node_modules/unix-shell-js/vi-editor.js"></script>
-    <script src="node_modules/unix-shell-js/example-files.js"></script>
+    <script src="node_modules/unix-shell-js/dist/index.js"></script>
+    <script src="node_modules/unix-shell-js/dist/vi-editor.js"></script>
+    <script src="node_modules/unix-shell-js/dist/example-files.js"></script>
     <script>
         // Create the shell with example files
         const shell = new UnixShell({