From c0decaedc421fd3535a2249a9d835e2296c34efd Mon Sep 17 00:00:00 2001 From: Christian Segundo Date: Tue, 24 Dec 2024 19:28:58 +0100 Subject: update readme --- README.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 2309496..fadfad8 100644 --- a/README.md +++ b/README.md @@ -19,14 +19,14 @@ desktop app logs to extract custom emojis and sync them to GitLab. 1. Then run the sync script: - ``` - export SLACK_WORKSPACE="..." # https://slack.com/help/articles/221769328-Locate-your-Slack-URL-or-ID - export GITLAB_TOKEN="..." # https://gitlab.com/-/user_settings/personal_access_tokens - export GITLAB_GROUP_PATH="..." # eg my_group - export GITLAB_URL="..." # optional, defaults to https://gitlab.com - export SLACK_LOGS_DIR="..." # optional, defaults to $HOME/Library/Application Support/Slack/logs/default - ./sync # where filter is a regex to match emoji names in Slack, eg '.*' for all emojis - ``` +```sh +export SLACK_WORKSPACE="..." # https://slack.com/help/articles/221769328-Locate-your-Slack-URL-or-ID +export GITLAB_TOKEN="..." # https://gitlab.com/-/user_settings/personal_access_tokens +export GITLAB_GROUP_PATH="..." # eg my_group +export GITLAB_URL="..." # optional, defaults to https://gitlab.com +export SLACK_LOGS_DIR="..." # optional, defaults to $HOME/Library/Application Support/Slack/logs/default +./sync # where filter is a regex to match emoji names in Slack, eg '.*' for all emojis +``` ### Docker @@ -41,18 +41,18 @@ desktop app logs to extract custom emojis and sync them to GitLab. 1. Run the sync script: - ``` - docker run --rm -it \ - -e SLACK_WORKSPACE="..." \ - -e GITLAB_TOKEN="..." \ - -e GITLAB_GROUP_PATH="..." \ - -e SLACK_LOGS_DIR="/slack-logs" \ - -v "$HOME/Library/Application Support/Slack/logs/default":/slack-logs \ - slack2gitlab-emoji-sync # where filter is a regex to match emoji names in Slack, eg '.*' for all emojis - ``` - _Note: Adjust the Slack logs directory depending on your OS._ +```sh +docker run --rm -it \ + -e SLACK_WORKSPACE="..." \ + -e GITLAB_TOKEN="..." \ + -e GITLAB_GROUP_PATH="..." \ + -e SLACK_LOGS_DIR="/slack-logs" \ + -v "$HOME/Library/Application Support/Slack/logs/default":/slack-logs \ + slack2gitlab-emoji-sync # where filter is a regex to match emoji names in Slack, eg '.*' for all emojis +``` + ## Caveats - If the same custom emoji is under different names in Slack, only the first -- cgit v1.2.3