diff --git a/README.md b/README.md index 85fd525..f0ec0b2 100644 --- a/README.md +++ b/README.md @@ -1 +1,26 @@ -# Run commandline tools in web \ No newline at end of file +# Quick guide + +## Install on a Linux host +``` +go install github.com/linuxexam/webrun@latest +``` + +## run any command, if not provided, default to sh +``` +~/go/bin/webrun +``` + +## access from browser +``` +http://your-server:8080 +``` +# screenshots +``` +webrun btop +``` +![image](examples/webrun_btop.png) + +``` +webrun vim /etc/passwd +``` +![image](examples/webrun_vim.png) \ No newline at end of file diff --git a/examples/webrun_btop.png b/examples/webrun_btop.png new file mode 100644 index 0000000..ad30848 Binary files /dev/null and b/examples/webrun_btop.png differ diff --git a/examples/webrun_vim.png b/examples/webrun_vim.png new file mode 100644 index 0000000..684e80c Binary files /dev/null and b/examples/webrun_vim.png differ