summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorIbrahim Serdar Acikgoz <serdaracikgoz86@gmail.com>2018-11-29 02:24:49 +0300
committerIbrahim Serdar Acikgoz <serdaracikgoz86@gmail.com>2018-11-29 02:24:49 +0300
commitc24dfe3255548c3b59d9ae93ba4f5258d0df67ac (patch)
tree6da8356767391eab9167fca7ff8c145b083657fd /README.md
parentshow remote commits added (diff)
downloadgitbatch-c24dfe3255548c3b59d9ae93ba4f5258d0df67ac.tar.gz
update readme file
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 13 insertions, 7 deletions
diff --git a/README.md b/README.md
index d9e9bce..15550cd 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,18 @@
[![Build Status](https://travis-ci.com/isacikgoz/gitbatch.svg?branch=master)](https://travis-ci.com/isacikgoz/gitbatch) [![MIT License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](/LICENSE) [![Go Report Card](https://goreportcard.com/badge/github.com/isacikgoz/gitbatch)](https://goreportcard.com/report/github.com/isacikgoz/gitbatch)
## gitbatch
-Aim of this tool to make your local repositories synchronized with remotes easily. 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 more elegant, I made a decision to create a simple tool to handle this job in a seamless way. Actually I am not a golang developer but I thought it would be cool to create this tool with a new language for me. While developing this project, I am getting experience with golang. As a result, I really enjoy working on this project and I hope it will be a useful tool. I hope this tool can be useful for others too. The satisfaction of saving someones precious time is priceless.
+Aim of this tool to make your local repositories synchronized with remotes easily. 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 more elegant, I made a decision to create a simple tool to handle this job in a seamless way. Actually I am not a golang developer but I thought it would be cool to create this tool with a new language for me. While developing this project, I am getting experience with golang. As a result, I really enjoy working on this project and I hope it will be a useful tool. I hope this tool can be useful for others too.
-**Disclamier** This is still a work in progress project.
+**Disclamier**
+- This is still a work in progress project.
+- Authentication reuqired repostires are **NOT SUPPORTED** 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)
+- This project is not widely tested in various environments. (macOS and Ubuntu is okay but didn't tried on Windows)
Here is the initial look of the project:
-[![asciicast](https://asciinema.org/a/eYfR9eWC4VGjiAyBUE7hpaZph.svg)](https://asciinema.org/a/eYfR9eWC4VGjiAyBUE7hpaZph)
+[![asciicast](https://asciinema.org/a/qmZDhmUjwWmZvdpZGYIRW56h7.svg)](https://asciinema.org/a/qmZDhmUjwWmZvdpZGYIRW56h7)
### Use
run the command the parent of your git repositories. Or simply:
@@ -16,14 +22,15 @@ run the command the parent of your git repositories. Or simply:
the project is at very very early version but if you like new adventures;
```
go get github.com/isacikgoz/gitbatch
-cd $GOPATH/src/github.com/isacikgoz/gitbatch
-go run main.go ".." # or simply go build && mv gitbatch $GOPATH/bin or any where you use as path
+gitbatch # whereever your git root is
```
## Further goals
+- select all feature
+- binary distrubiton over [homebrew](https://github.com/Homebrew/brew) or similar
- recursive repository search from the filesystem
- full src-d/go-git integration (*waiting for merge abilities*)
-- implement modal base ux like vim (fetch/merge *maybe* even push)
+- implement config file to pre-define repo locations or some settings
- resolve authentication issues
- *maybe* handle conflicts with [fac](https://github.com/mkchoi212/fac) integration
@@ -31,5 +38,4 @@ go run main.go ".." # or simply go build && mv gitbatch $GOPATH/bin or any where
- [go-git](https://github.com/src-d/go-git) for git interface
- [gocui](https://github.com/jroimartin/gocui) for user interface
- [color](https://github.com/fatih/color) for colored text
-- [lazygit](https://github.com/jesseduffield/lazygit) for reference
- [kingpin](https://github.com/alecthomas/kingpin) for command-line flag&options