added readme

mhristof · Sep 25, 2020 · bf75700 · bf75700
1 parent 0f285d2
commit bf75700
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,20 @@
+# gitbrose
+
+command line utility that is able to translate any local git file to the web page of its remote.
+
+Supported types of remotes are:
+
+* Github
+* Gitlab
+* AWS CodeCommit
+
+## Examples
+
+### Github with ssh remote
+
+```
+$ git config --get remote.origin.url
+[email protected]:mhristof/gitbrowse.git
+$ gitbrowse Makefile
+https://github.com/mhristof/gitbrowse/blob/master/Makefile
+```