Skip to content

Commit

Permalink
docs: update READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
doronz88 committed Feb 4, 2022
1 parent 4b27b4c commit 1156796
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@

## Description

Simple C server for achieving a nice remote shell allowing:
* Remote C function calls
* Remote shell commands
* Remote filesystem management
Simple remote control process requiring a single executable to be uploaded and run on the remote host.
This executable then provides a protocol to call native C functions which makes it possible to control
every aspect of the connected machine.

For more information about the client which utilizes these abilities, please view its README here:
https://github.com/doronz88/zshell/tree/master/src/pyzshell

## Building C Server

Expand Down Expand Up @@ -42,5 +44,5 @@ To execute the server:
Connecting via:

```shell
python3 -m pyzshell ishell <HOST>
python3 -m pyzshell <HOST> ishell
```
4 changes: 3 additions & 1 deletion src/pyzshell/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ Simple python3 client achieving a nice remote shell allowing:
* Remote C function calls
* Remote shell commands
* Remote filesystem management
* Remote process management
* Remote network apis (create tcp connections, unix domain, and more...)

## Installing python client

Expand All @@ -20,7 +22,7 @@ python3 -m pip install --user -U .
Connecting via:

```shell
python3 -m pyzshell ishell <HOST>
python3 -m pyzshell <HOST> ishell
```

Here are some examples of things you may do:
Expand Down

0 comments on commit 1156796

Please sign in to comment.