feat: clean up docs and code

krzko · Nov 13, 2023 · 9c2ccc7 · 9c2ccc7
1 parent 39da2dc
commit 9c2ccc7
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -84,11 +84,39 @@ Slack Buddy custom and scheduled statuses can be added via updating the`config.y
 * **macOS**: `~/.slack-buddy/config.yaml`
 * **Windows**: Not tested yet
 
+### `api_token`
+
+You will need to retrieve a Personal Token from a Slack Workspace Administrator. You can get more details from the Slack [Access Tokens](https://api.slack.com/authentication/token-types) page.
+
+### `user_id`
+
+To retrieve youe `user_id` value, follow these steps:
+
+* Open **Slack**.
+* Open **Profile** window.
+* Select the **three vertical dots** next to **View As**.
+* Select **Copy memeber ID**.
+
+### `disaply_name`
+
+* This is the default disaply name value. All statuses will be set via **`display_name` + "is ..."**.
+* This is the value that is set when you select **Clear Status**.
+
+### Example Configuration
+
+* The `title` value has to be unique.
+* Custom statuses do not have `days`, `start_time` or `end_time` values set.
+* Ensure the `status_emoji` value exists in your Slack workspace.
+
 ```yaml
 api_token: xoxp-xxx-xxx-xxx-xxx
 user_id: XXXXXXXXX
 display_name: Kristof
 custom_items:
+  - title: "Zwift"
+    tooltip: ""
+    status_text: "on Zwift"
+    status_emoji: ":bike:"
   - title: "School Run"
     tooltip: ""
     status_text: "on a school run"

diff --git a/pkg/slack/slack.go b/pkg/slack/slack.go
@@ -57,15 +57,6 @@ func (c *StdLibClient) UpdateDisplayName(userID, displayName string) error {
 	}
 	defer resp.Body.Close()
 
-	// New logging
-	// respBody, err := io.ReadAll(resp.Body)
-	// if err != nil {
-	// 	return err
-	// }
-	// fmt.Printf("Response status: %s, body: %s\n", resp.Status, string(respBody))
-
-	// Handle the response (e.g., check for success, handle errors, etc.)
-
 	return nil
 }
 

diff --git a/pkg/systray/systray.go b/pkg/systray/systray.go
@@ -26,13 +26,9 @@ func OnReady() {
 	// Load configuration
 	cfg, err := config.LoadConfig()
 	if err != nil {
-		// Handle error (e.g., log it)
-		cfg = &config.Config{} // Create a new config if loading failed
+		cfg = &config.Config{}
 	}
 
-	// After loading the config, check for duplicate titles
-	checkForDuplicateTitles(cfg.CustomItems)
-
 	handler := &SystrayHandler{
 		cfg: cfg,
 	}
@@ -42,6 +38,9 @@ func OnReady() {
 	if handler.cfg.ApiToken == "your_default_api_token" || handler.cfg.UserId == "your_default_user_id" || handler.cfg.DisplayName == "your_default_display_name" {
 		openSettingsDialog(cfg)
 	}
+
+	// After loading the config, check for duplicate titles
+	checkForDuplicateTitles(cfg.CustomItems)
 }
 
 func (h *SystrayHandler) getSlackClient() (*slack.SlackClient, error) {
@@ -273,7 +272,6 @@ func (h *SystrayHandler) initializeSystray() {
 		}
 	}()
 
-	// New goroutine for handling custom menu items and separating scheduled items
 	// New goroutine for handling custom menu items and separating scheduled items
 	if len(h.cfg.CustomItems) > 0 {
 		go func() {
@@ -305,7 +303,7 @@ func openSettingsDialog(cfg *config.Config) {
 		fmt.Printf("Error displaying User ID dialog: %v\n", err)
 		return
 	}
-	cfg.UserId = userId // Update the value
+	cfg.UserId = userId
 
 	displayName, _, err := dlgs.Entry("Display Name", "Enter your Slack Display Name:", cfg.DisplayName)
 	if err != nil {
@@ -395,7 +393,6 @@ func (h *SystrayHandler) unsetStatus() error {
 	return slackClient.UnsetStatus()
 }
 
-// findCustomItemByStatusText finds a custom item by its status text.
 func findCustomItemByStatusText(items []config.CustomItem, statusText string) *config.CustomItem {
 	for _, item := range items {
 		if item.StatusText == statusText {
@@ -405,7 +402,6 @@ func findCustomItemByStatusText(items []config.CustomItem, statusText string) *c
 	return nil
 }
 
-// findCustomItemByTitle finds a custom item by its title.
 func findCustomItemByTitle(items []config.CustomItem, title string) *config.CustomItem {
 	for _, item := range items {
 		if item.Title == title {
@@ -415,7 +411,6 @@ func findCustomItemByTitle(items []config.CustomItem, title string) *config.Cust
 	return nil
 }
 
-// checkForDuplicateTitles checks for duplicate titles in the custom items and exits if found.
 func checkForDuplicateTitles(items []config.CustomItem) {
 	titles := make(map[string]bool)
 	for _, item := range items {