From 875305869a90017a83991d80134a91f7b4d166c2 Mon Sep 17 00:00:00 2001 From: RGBCube Date: Fri, 11 Apr 2025 19:41:41 +0300 Subject: [PATCH] doc: specify case sensitivity --- README.md | 20 ++++++++++---------- github2forgejo | 2 +- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index f42e06b..11bea53 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Migrates a GitHub users repositories to a Forgejo instance. Accepted environment variables: - GITHUB_USER: The user to fetch the repositories from. + GITHUB_USER: The user to fetch the repositories from. Case sensitive. GITHUB_TOKEN: An access token for fetching private repositories. Optional. FORGEJO_URL: The URL to the Forgejo instance. Must include the protocol (https://). @@ -37,12 +37,13 @@ Usage: > github2forgejo Flags: - -h, --help - Display the help message for this command + -h, --help: Display the help message for this command ``` + -You can either specify all the environment variables -for a uninteractive run, or run the script like so: +You can either specify all the environment variables for a uninteractive run, or +run the script like so: ```nu ./github2forgejo @@ -119,13 +120,12 @@ The script is also available as a package, you just need to use the ### What is the difference between mirroring and cloning? -- **Mirroring:** Will get updated every now and then, - keeping the repository in sync with the remote. +- **Mirroring:** Will get updated every now and then, keeping the repository in + sync with the remote. -- **Cloning:** Will only clone the remote, and will - not update or link to it anywhere in the repository. - This is good for when you are migrating off GitHub permanently - and will never come back. +- **Cloning:** Will only clone the remote, and will not update or link to it + anywhere in the repository. This is good for when you are migrating off GitHub + permanently and will never come back. ### Can I migrate specific repositories? diff --git a/github2forgejo b/github2forgejo index e8c6888..8e1cd15 100755 --- a/github2forgejo +++ b/github2forgejo @@ -12,7 +12,7 @@ def or-default [default: closure] { # # Accepted environment variables: # -# GITHUB_USER: The user to fetch the repositories from. +# GITHUB_USER: The user to fetch the repositories from. Case sensitive. # GITHUB_TOKEN: An access token for fetching private repositories. Optional. # # FORGEJO_URL: The URL to the Forgejo instance. Must include the protocol (https://).