From fb5de2ec1fada8fa745441a149eac99213a987f3 Mon Sep 17 00:00:00 2001 From: Jay Gabriels Date: Sat, 28 Oct 2023 11:01:02 -0700 Subject: [PATCH] Update README.md --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 129460d..b03bdfa 100644 --- a/README.md +++ b/README.md @@ -34,18 +34,6 @@ Use ghorg to quickly clone all of an orgs, or users repos into a single director > The terminology used in ghorg is that of GitHub, mainly orgs/repos. GitLab and BitBucket use different terminology. There is a handy chart thanks to GitLab that translates terminology [here](https://about.gitlab.com/images/blogimages/gitlab-terminology.png). Note, some features may be different for certain providers. -## Configuration - -Precedence for configuration is first given to the flags set on the command-line, then to what's set in your `$HOME/.config/ghorg/conf.yaml`. This file comes from the [sample-conf.yaml](https://github.com/gabrie30/ghorg/blob/master/sample-conf.yaml). - -If no configuration is found ghorg will use its defaults and try to clone a GitHub Org, however an api token is always required. - -You can have multiple configuration files which is useful if you clone from multiple SCM providers with different tokens and settings. Alternative configuration files can only be referenced as a command-line flag `--config`. - -If you have multiple different orgs/users/configurations to clone see the `ghorg reclone` command as a way to manage them. - -Note: ghorg will respect the `XDG_CONFIG_HOME` [environment variable](https://wiki.archlinux.org/title/XDG_Base_Directory) if set. - ## Installation There are a installation methods available, please choose the one that suits your fancy: @@ -98,6 +86,18 @@ See [latest release](https://github.com/gabrie30/ghorg/releases/latest) to downl If you don't know which to choose its likely going to be the x86_64 version for your operating system. +## Configuration + +Precedence for configuration is first given to the flags set on the command-line, then to what's set in your `$HOME/.config/ghorg/conf.yaml`. This file comes from the [sample-conf.yaml](https://github.com/gabrie30/ghorg/blob/master/sample-conf.yaml). + +If no configuration is found ghorg will use its defaults and try to clone a GitHub Org, however an api token is always required. + +You can have multiple configuration files which is useful if you clone from multiple SCM providers with different tokens and settings. Alternative configuration files can only be referenced as a command-line flag `--config`. + +If you have multiple different orgs/users/configurations to clone see the `ghorg reclone` command as a way to manage them. + +Note: ghorg will respect the `XDG_CONFIG_HOME` [environment variable](https://wiki.archlinux.org/title/XDG_Base_Directory) if set. + ## SCM Provider Setup > Note: if you are running into issues, read the troubleshooting and known issues section below