From 98ac87e627ff397c5b9a62d586c3777ad2e6bdd0 Mon Sep 17 00:00:00 2001
From: Oleksandr Redko <oleksandr.red+github@gmail.com>
Date: Wed, 3 Apr 2024 14:04:52 +0300
Subject: [PATCH] Update README: improve formatting; fix blog link (#62)

---
 README.md | 51 ++++++++++++++++++++++++++++-----------------------
 1 file changed, 28 insertions(+), 23 deletions(-)

diff --git a/README.md b/README.md
index d4c7632..a3d26a1 100644
--- a/README.md
+++ b/README.md
@@ -5,27 +5,30 @@
 
 The tool to import commits from private GitLab to separate repo. Can be used to show your programming activity for another company in GitHub.
 
-Check out this informative blog post on how to import GitLab commits at https://www.alexandear.tech/posts/2023-03-08-import-gitlab-commits/ for a practical use case.
+Check out this informative blog post for a practical use case on how to import GitLab commits [here](https://alexandear.github.io/posts/2023-03-08-import-gitlab-commits/).
 
-# Getting Started
+## Getting Started
 
 1. Download and install [Go 1.22](https://go.dev/dl/).
 2. Install the program by running the command in a shell:
-```shell
-go install github.com/alexandear/import-gitlab-commits@latest
-```
+
+    ```shell
+    go install github.com/alexandear/import-gitlab-commits@latest
+    ```
 
 3. Set environment variables and run `import-gitlab-commits`:
-```shell
-export GITLAB_BASE_URL=<your_gitlab_server_url>
-export GITLAB_TOKEN=<your_gitlab_token>
-export COMMITTER_NAME="<Name Surname>"
-export COMMITTER_EMAIL=<mail@example.com>
 
-$(go env GOPATH)/bin/import-gitlab-commits
-```
+    ```shell
+    export GITLAB_BASE_URL=<your_gitlab_server_url>
+    export GITLAB_TOKEN=<your_gitlab_token>
+    export COMMITTER_NAME="<Name Surname>"
+    export COMMITTER_EMAIL=<mail@example.com>
+
+    $(go env GOPATH)/bin/import-gitlab-commits
+    ```
 
 where
+
 - `GITLAB_BASE_URL` is a GitLab [instance URL](https://stackoverflow.com/questions/58236175/what-is-a-gitlab-instance-url-and-how-can-i-get-it), e.g. `https://gitlab.com`, `https://gitlab.gnome.org` or any GitLab server;
 - `GITLAB_TOKEN` is a personal [access token](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#create-a-personal-access-token);
 - `COMMITTER_NAME` is your GitHub name with surname, e.g. `John Doe` (can be passed to `git config user.name`);
@@ -36,27 +39,29 @@ where
 
 Contributions before running `import-gitlab-commits`:
 
-<img src="./screenshots/contribs_before.png" width="1000">
+<img alt="Screenshot of GitHub contributions before running import-gitlab-commits" src="./screenshots/contribs_before.png" width="1000">
 
 After:
 
-<img src="./screenshots/contribs_after.png" width="1000">
+<img alt="Screenshot of GitHub contributions after running import-gitlab-commits with new activity" src="./screenshots/contribs_after.png" width="1000">
 
-# Internals
+## Internals
 
 What work the tool does:
-* gets current user info by `GITLAB_TOKEN`;
-* fetches from `GITLAB_BASE_URL` projects that the current user contributed to;
-* for all projects fetches commits where author's email is the current user's email;
-* creates new repo `repo.gitlab.yourcompany.com.currentusername` and commits all fetched commits with message
+
+- gets current user info by `GITLAB_TOKEN`;
+- fetches from `GITLAB_BASE_URL` projects that the current user contributed to;
+- for all projects fetches commits where author's email is the current user's email;
+- creates new repo `repo.gitlab.yourcompany.com.currentusername` and commits all fetched commits with message
 `Project: GITLAB_PROJECT_ID commit: GITLAB_COMMIT_HASH`, commit date `GITLAB_COMMIT_DATE`, and commit author `COMMITTER_NAME <COMMITTER_EMAIL>`.
 
 To show the changes on GitHub you need to:
-* create a new repo `yourcompany-contributions` in GitHub;
-* open folder `repo.gitlab.yourcompany.com.currentusername`;
-* add remote url `git remote add origin git@github.com:username/yourcompany-contributions.git`;
-* push changes.
 
+- create a new repo `yourcompany-contributions` in GitHub;
+- open folder `repo.gitlab.yourcompany.com.currentusername`;
+- add remote url `git remote add origin git@github.com:username/yourcompany-contributions.git`;
+- push changes.
 
 ## License
+
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Falexandear%2Fimport-gitlab-commits.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Falexandear%2Fimport-gitlab-commits?ref=badge_large)