updated readme

Author: daviidy

README.md

@@ -1,34 +1,121 @@
-[![progress-banner](https://backend.codecrafters.io/progress/shell/5814aa72-3c12-4fe3-9365-43070362cba0)](https://app.codecrafters.io/users/codecrafters-bot?r=2qF)
+# Build Your Own Shell
 
-This is a starting point for JavaScript solutions to the
-["Build Your Own Shell" Challenge](https://app.codecrafters.io/courses/shell/overview).
+This project is a custom implementation of a POSIX-compliant shell built in JavaScript. It supports executing external commands, built-in commands, and features like tab completion, command parsing, and redirection.
 
-In this challenge, you'll build your own POSIX compliant shell that's capable of
-interpreting shell commands, running external programs and builtin commands like
-cd, pwd, echo and more. Along the way, you'll learn about shell command parsing,
-REPLs, builtin commands, and more.
+## Features
 
-**Note**: If you're viewing this repo on GitHub, head over to
-[codecrafters.io](https://codecrafters.io) to try the challenge.
+- **Built-in Commands**:
+  - `cd`: Change the current working directory.
+  - `pwd`: Print the current working directory.
+  - `echo`: Print arguments to standard output.
+  - `exit`: Exit the shell.
+  - `type`: Display information about a command (e.g., whether it's built-in or external).
 
-# Passing the first stage
+- **External Commands**:
+  - Executes programs available in the system's `PATH`.
 
-The entry point for your `shell` implementation is in `app/main.js`. Study and
-uncomment the relevant code, and push your changes to pass the first stage:
+- **Tab Completion**:
+  - Autocompletes built-in commands and external executables.
+  - Handles cases where multiple matches exist, completing to the longest common prefix or displaying all matches.
 
-```sh
-git commit -am "pass 1st stage" # any msg
-git push origin master
+- **Redirection**:
+  - Supports output redirection (`>`, `>>`) and error redirection (`2>`, `2>>`).
+
+- **Error Handling**:
+  - Gracefully handles invalid commands and displays appropriate error messages.
+
+## Getting Started
+
+### Prerequisites
+
+- **Node.js**: Ensure you have Node.js (version 21 or higher) installed on your system.
+
+### Installation
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/your-username/build-your-own-shell.git
+   cd build-your-own-shell
+   ```
+
+2. Install dependencies
+   ```bash
+   npm install
+   ```
+
+### Running the Shell
+To start the shell, run:
+   ```bash
+   ./your_program.sh
+   ```
+
+You will see a prompt ($ ) where you can enter commands.
+
+### Usage
+
+#### Built-in Commands
+
+- cd <directory>: Change the current working directory.
+```bash
+$ cd /path/to/directory
+```
+
+- pwd: Print the current working directory.
+```bash
+$ pwd
 ```
 
-Time to move on to the next stage!
+- echo <text>: Print text to standard output.
+```bash
+$ echo Hello, World!
+```
+
+- exit: Exit the shell.
+```bash
+$ exit
+```
+
+- type <command>: Display information about a command.
+```bash
+$ type echo
+echo is a shell builtin
+```
+
+#### External Commands
+You can run any executable available in your system's PATH. For example:
+$ ls -l
+$ node --version
+
+#### Tab Completion
+Press <TAB> to autocomplete commands or filenames.
+If multiple matches exist, press <TAB> twice to display all matches.
+
+#### Redirection
+- Redirect standard output to a file:
+$ echo "Hello" > output.txt
+
+- Append to a file:
+$ echo "World" >> output.txt
+
+- Redirect standard error:
+$ ls nonexistentfile 2> error.log
+
+- Append standard error:
+$ ls nonexistentfile 2>> error.log
+
+### Development
+
+#### Project Structure
+
+- `app/main.js`: Entry point for the shell.
+- `app/InputHandler.js`: Handles user input and tab completion.
+- `app/OutputHandler.js`: Handles output and redirection.
+- `app/CommandRegistry.js`: Manages built-in and external commands.
+- `app/<CommandName>.js`: Implementations of built-in commands (e.g., CdCommand, PwdCommand).
 
-# Stage 2 & beyond
+#### Adding a New Built-in Command
 
-Note: This section is for stages 2 and beyond.
+- Create a new file in the app directory (e.g., MyCommand.js).
+- Extend the Command class and implement the execute method.
+- Register the command in main.js:
 
-1. Ensure you have `node (21)` installed locally
-1. Run `./your_program.sh` to run your program, which is implemented in
-   `app/main.js`.
-1. Commit your changes and run `git push origin master` to submit your solution
-   to CodeCrafters. Test output will be streamed to your terminal.