diff --git a/README.md b/README.md index a48c0b4..013270d 100644 --- a/README.md +++ b/README.md @@ -56,21 +56,23 @@ Maybe slightly in order of importance - but not necessarily order of implementat * [Private message support, just for the fun of it](https://github.com/JKrag/GitSlick/issues/4) * [Support running in split-screen terminal](https://github.com/JKrag/GitSlick/issues/5) * [Add a run-mode where chat takes place under the hood in an existing repo](https://github.com/JKrag/GitSlick/issues/6) -* I had the idea that it might be a good idea with a small safety check to avoid running chat.sh in the wrong repo. My initial thought was that it could be as simple as checking for the existance of a possibly empty `.gitslick` file in the root of the repo, and aborting f this doesn't exist. But writing this, I realise that it would either have to be an untracked file, or it would have to be copied over and added to each new branch. maybe it could look for this file in the .git folder? More thinking needed. +* I had the idea that it might be a good idea with a small safety check to avoid running chat.sh in the wrong repo. My initial thought was that it could be as simple as checking for the existance of a possibly empty `.gitslick` file in the root of the repo, and aborting if this doesn't exist. But writing this, I realise that it would either have to be an untracked file, or it would have to be copied over and added to each new branch. maybe it could look for this file in the .git folder? More thinking needed. ## Docker In case you want chat without cloning the chat repo locally, and without leaving too many traces on your computer, -you acn run the whoe thing in Docker. +you can run the whole thing in Docker. ### Build image -``` +```bash docker build -t gitslick . ``` ### Run image -``` +```bash docker run --name tempchat --rm -it -v ~/.ssh:/tmp/.ssh:ro gitslick -r git@github.com:JKrag/demo.git -e "jankrag@gmail.com" -n "Whale Hail" ``` + +The options `-e` & `-n` (email & name) are documented in the `entrypoint.sh` script being run by the container.