Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cs01 committed Dec 9, 2020
1 parent 6cabb4d commit f4236c0
Showing 1 changed file with 32 additions and 7 deletions.
39 changes: 32 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,26 +29,51 @@ This is a

## Installation

There are a few ways to install and run.

### Clone & Run Locally
Clone this repository, enter the `pyxtermjs` directory, then run:
```
> python -m venv venv # must be python3.6+
> venv/bin/pip install -r requirements.txt
> venv/bin/python -m pyxtermjs
serving on http://127.0.0.1:5000
```

### Install or Run latest version on PyPI
You can use [pipx](https://github.com/pipxproject/pipx) to try it out.
```
> pipx run pyxtermjs
serving on http://127.0.0.1:5000
```

You can also and have `pyxtermjs` installed in an isolated environment, yet available on your $PATH with
```
> pipx install pyxtermjs
```
python3 -m venv venv # must be python3.6+
venv/bin/pip install -r requirements.txt
venv/bin/python -m pyxtermjs

### Run from GitHub source
Use [pipx](https://github.com/pipxproject/pipx) for this as well.
```
> pipx run --spec git+https://github.com/cs01/pyxtermjs.git pyxtermjs
serving on http://127.0.0.1:5000
```


## Documentation
## API
```
>> pyxtermjs --help
usage: pyxtermjs [-h] [-p PORT] [--debug] [--version] [--command COMMAND]
[--cmd-args CMD_ARGS]
> pyxtermjs --help
usage: pyxtermjs [-h] [-p PORT] [--host HOST] [--debug] [--version]
[--command COMMAND] [--cmd-args CMD_ARGS]
A fully functional terminal in your browser.
https://github.com/cs01/pyxterm.js
optional arguments:
-h, --help show this help message and exit
-p PORT, --port PORT port to run server on (default: 5000)
--host HOST host to run server on (use 0.0.0.0 to allow access
from other hosts) (default: 127.0.0.1)
--debug debug the server (default: False)
--version print version and exit (default: False)
--command COMMAND Command to run in the terminal (default: bash)
Expand Down

0 comments on commit f4236c0

Please sign in to comment.