updated dockerfile, install loc

[gen-shell.git] / README.md

diff --git a/README.md b/README.md
index 481053d4e7edc3dd5a06969ae9c1cc2e7bdaeaca..3a62a96872a5a452421c44649e8e99483345741f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
 A simple way to turn any command into a shell with arrow key/history support (if compiled with libreadline). Forked from [taskshell](https://github.com/GothenburgBitFactory/taskshell).
 
 ## Usage
-Just put the command that you want to repeat after the c flag, eg; `gen-shell -c ls`, or even something much more complex like `gen-shell -c "cd /home/armaa/Clone/words && /home/armaa/Clone/words/bin/words"` This command was actually the inspiration for gen-shell.
+See `gen-shell --help`
 
 ## Installation
 ### From a binary
@@ -27,23 +27,18 @@ Then download and build gen shell:
 git clone --recursive https://codeberg.org/armaan/gen-shell
 cd gen-shell
 cmake .
-make
-sudo cp src/gen-shell /usr/bin/
+sudo make install
 ```
-Or, if you don't have root access, you can subsitute the last line with
-`cp src/gen-shell ~/.local/bin`
-
 ### Docker
 You can also run gen-shell in docker. Simply use
 ```bash
-docker run -it -e CMD=<command-to-run> armaanb/gen-shell
+docker run -it -e command=<command> -e before_command=<before command> -e after_command=<after command> -e custom_prompt=<custom prompt> armaanb/gen-shell
 ```
 Or to build the docker container locally, run:
 ```bash
 git clone --recursive https:/codeberg.org/armaan/gen-shell
 cd gen-shell
 docker build --no-cache -t gen-shell:latest .
-docker run -it -e CMD=<command-to-run> gen-shell
 ```
 ## License
 Following suit from taskshell, gen-shell is MIT licensed by Armaan Bhojwani, 2020. Gen-shell is forked from taskshell, which was developed by [these people](https://github.com/GothenburgBitFactory/taskshell/blob/master/AUTHORS).