Skip to content

Commit bb6515a

Browse files
authored
Update README.md
1 parent 70a2f99 commit bb6515a

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# JSShell
22

3-
An interactive multi-user web based shell written in Python with Flask (for server side) and of course Javascript and HTML (client side). It was initally created in order to debug remote isoteric browsers during tests and research. I am well aware of other purposes this tool might serve, use it at your own responabilty and risk.
3+
An interactive multi-user web based JS shell written in Python with Flask (for server side) and of course Javascript and HTML (client side). It was initially created to debug remote esoteric browsers during tests and research. I'm aware of other purposes this tool might serve, use it at your own responsibility and risk.
44

55
## Author
66
[Daniel Abeles](https://twitter.com/Daniel_Abeles).
@@ -43,7 +43,7 @@ python db_handler.py create
4343
python run.py
4444
```
4545
### Navigate with a browser to the server address
46-
If you running localy, then navigate to `http://localhost:5000` (port can be changed)
46+
If you running localy, then navigate to `http://localhost:5000` (port and host can of course be changed)
4747

4848
### Open the interactive shell
4949
```python
@@ -56,7 +56,7 @@ Those are scripts that will execute on every registration of a new client. Use t
5656
##### Profit :)
5757

5858
### Usage
59-
The shell interface contains various commands (can be reavealed using the `help` command).
59+
The shell interface contains various commands (can be revealed using the `help` command).
6060
```bash
6161
╦╔═╗╔═╗┬ ┬┌─┐┬ ┬
6262
║╚═╗╚═╗├─┤├┤ │ │
@@ -81,7 +81,7 @@ The shell interface contains various commands (can be reavealed using the `help`
8181

8282
```
8383
Utilizing the command queue, you can fire mutliple commands and the client will execute them one by one.
84-
All the commands are executed using a single context, so you issue mutiple related commands.
84+
All the commands are executed using a single context, so all of the commands are aware of each other (same scope).
8585
8686
To view the commands issued to a client, first select a client:
8787
```python
@@ -100,23 +100,23 @@ To view the full command and it's full output (on the `coms` command the output
100100
## Workflow
101101
After all the installations and configuration is done, the workflow of the application is the following:
102102
103-
1. Client visits the home page `http://localhost:5000/`
103+
1. Client visits the home page `http://localhost:5000/` (or the host you chose)
104104
105-
2. He makes a `register` request to the server
105+
2. The client makes an asynchronous `register` request to the server
106106
107-
3. Waits for commands
107+
3. Then he waits for commands
108108
109109
4. In the meanwhile, on the server, you execute commands using the `shell.py` script
110110
111-
5. The client probes the server for commands, see a new one appeared, pulls it and executes it
111+
5. The client probes the server for commands, when he sees a new one appeared, he pulls it and executes it
112112
113113
6. Once he's done executing, he will post back the result to the server
114114
115-
7. Now, using the `coms` command, we can see the output for that command
115+
7. Now, using the `coms` command, you can see the output for that command
116116
117117
118118
## Database Handling
119-
I have included a script that i've been using during tests, which is the `db_handler.py` file. It includes varius function to handle and test your database.
119+
I have included a script that I've been using during tests, which is the `db_handler.py` file. It includes varius function to handle and test your database.
120120
121121
122122
## Credits

0 commit comments

Comments
 (0)