diff options
| -rw-r--r-- | bitbucket-widget/README.md | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/bitbucket-widget/README.md b/bitbucket-widget/README.md index a0cae0a..7f82e73 100644 --- a/bitbucket-widget/README.md +++ b/bitbucket-widget/README.md @@ -4,9 +4,9 @@ The widget shows the number of pull requests assigned to the user and when click ## How it works -Widget uses cURL to query Bitbucket's [REST API](https://developer.atlassian.com/bitbucket/api/2/reference/). In order to be authenticated, widget uses a [netrc](https://ec.haxx.se/usingcurl/usingcurl-netrc) feature of the cURL, which is basically to store basic auth credentials in a .netrc file in home folder. +Widget uses cURL to query Bitbucket's [REST API](https://developer.atlassian.com/bitbucket/api/2/reference/). In order to be authenticated, widget uses a [netrc](https://ec.haxx.se/usingcurl/usingcurl-netrc) feature of the cURL, which is basically allows storing basic auth credentials in a **.netrc** file in home folder. -Bitbucket allows using [App Passwords](https://confluence.atlassian.com/bitbucket/app-passwords-828781300.html) (available in the account settings) - simply generate one for the widget and use it as password in .netrc file. +Bitbucket allows using [App Passwords](https://confluence.atlassian.com/bitbucket/app-passwords-828781300.html) (available in the account settings) - simply generate one for the widget and use it as password in **.netrc** file. ## Customization @@ -15,15 +15,19 @@ It is possible to customize widget by providing a table with all or some of the | Name | Default | Description | |---|---|---| | `icon` | `~/.config/awesome/awesome-wm-widgets/bitbucket-widget/bitbucket-icon-gradient-blue.svg` | Path to the icon | -| `host` | Required | Ex: _http://api.bitbucket.org_ | -| `uuid` | Required | UUID | +| `host` | Required | e.g _http://api.bitbucket.org_ | +| `uuid` | Required | e.g _{123e4567-e89b-12d3-a456-426614174000}_ | | `workspace` | Required | Workspace ID| | `repo_slug` | Required | Repository slug | | `timeout` | 60 | How often in seconds the widget refreshes | +Note: + - host most likely should start with _api._ + - to get your UUID you may call `curl -s -n 'https://api.bitbucket.org/2.0/user'` + ## Installation -Create a .netrc file in you home directory with following content: +Create a **.netrc** file in you home directory with following content: ```bash machine api.bitbucket.org @@ -56,7 +60,7 @@ s.mytasklist, -- Middle widget -- default bitbucket_widget({ host = 'https://api.bitbucket.org', - uuid = 'your-uuid', + uuid = '{123e4567-e89b-12d3-a456-426614174000}', workspace = 'workspace', repo_slug = 'slug' |