summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 9 insertions, 9 deletions
diff --git a/README.md b/README.md
index 7dd197c..ed3396a 100644
--- a/README.md
+++ b/README.md
@@ -4,24 +4,24 @@
Aim of this tool to make your local repositories synchronized with remotes easily. I inspired from lazygit and decided to build this project for my needs; Since my daily work is tied to many repositories I often end up walking on many directories and manually pulling updates etc. To make this routine faster, I created a simple tool to handle this job. I really enjoy working on this project and I hope it will be a useful tool.
**Disclaimer**
-- Authentication required repositories are **not supported** so using ssh is recommended if you need to authenticate to fetch/pull
+- Unauthenticated repositories are **not supported** so using ssh is recommended if you need to authenticate to fetch/pull
- [Connecting to GitHub with SSH](https://help.github.com/articles/connecting-to-github-with-ssh/)
- [GitLab and SSH keys](https://docs.gitlab.com/ee/ssh/)
- [BitBucket Set up an SSH key](https://confluence.atlassian.com/bitbucket/set-up-ssh-for-git-728138079.html)
- Feedbacks are welcome. For now, known issues are:
- - At very low probability app fails to load repositories, try again it will load next time (multithreading problem)
- - Sometimes when you scroll too fast while pulling/fetching/merging, some multithreading problem occurs and app crashes (will fix soon)
- - colors vary to your terminal theme colors, so if the contrast is not enough on some color decisions; discussions are welcome
+ - At very low probability app fails to load repositories, try again it will load next time (multithreading problem).
+ - Sometimes when you scroll too fast while pulling/fetching/merging, some multithreading problem occurs and app crashes (will fix soon).
+ - Colors vary to your terminal theme colors, so if the contrast is not enough on some color decisions; discussions are welcome.
Here is the screencast of the app:
[![asciicast](https://asciinema.org/a/B4heYReiNgqwUbWL2RYnTzt5H.svg)](https://asciinema.org/a/B4heYReiNgqwUbWL2RYnTzt5H)
-## installation
-for now, installation requires golang compiler and minimum golang 1.10 is recommended.
-- if you don't have golang installed refer to [golang.org](https://golang.org/dl/)
-- you should have $GOPATH env variable set and your $PATH should include $GOPATH/bin to run app from anywhere
+## Installation
+For now, installation requires golang compiler and minimum golang 1.10 is recommended.
+- If you don't have golang installed refer to [golang.org](https://golang.org/dl/).
+- You should have $GOPATH env variable set and your $PATH should include $GOPATH/bin to run app from anywhere.
-to install run the command;
+To install run the following command;
```bash
go get -u github.com/isacikgoz/gitbatch
```