Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
logandhillon committed Jul 12, 2024
1 parent 719d94e commit afc8cce
Showing 1 changed file with 22 additions and 5 deletions.
27 changes: 22 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,27 @@
# BadOS Dynamic Shell (bdsh)

## Usage
Read the docs at 🔗 [badtechnologies.github.io/bdsh](https://badtechnologies.github.io/bdsh).
## Installation

Run the `config.py` script, and follow the on-screen instructions.
1. **Download the latest release**

> [!NOTE]
> At least ONE user must exist for bdsh to function
Or, you can directly download `config.py` and `bdsh.py` from the [repo](https://github.com/badtechnologies/bdsh).

Once the `/bdsh` directory and your configs are prepared, you can start bdsh with `bdsh.py` to launch the interactive shell.
2. **Setup bdsh:**

```sh
python3 config.py
```

Follow the on-screen instructions.

> [!NOTE]
> At least ONE user must exist for bdsh to function

Once the `/bdsh` directory and your configs are prepared, you can start bdsh with `bdsh.py` to launch the interactive shell.

3. **Launch bdsh:**

```sh
python3 bdsh.py
```

0 comments on commit afc8cce

Please sign in to comment.