diff --git a/README.md b/README.md index 4b5f1d9..ee8ca84 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ -# fj +Ferret Junior, the mascot of software project 'FJ', a command line tool to interface with the forgejo git forge. A young ferret standing on two legs, smiling, with a shirt saying 'FJ' in reddish brown letters, computers in the ground. Logo, white background, cut out, not realistic. +
-A Forgejo CLI - "gh for Forgejo" +# A Forgejo CLI - "gh for Forgejo" ## Configuration @@ -12,7 +13,9 @@ cp .env.example .env Required variables: - `FJ_HOST`: Your Forgejo instance URL +- `FJ_USERNAME`: Your Forgejo username - `FJ_API_TOKEN`: Your Forgejo API token - `FJ_SSH_KEY_PATH`: Path to your SSH key +- `FJ_SSH_USER`: SSH user for your Forgejo instance Environment variables take precedence over values in the .env file. \ No newline at end of file diff --git a/logo.png b/logo.png new file mode 100755 index 0000000..412a2e7 Binary files /dev/null and b/logo.png differ