Skip to content

Commit

Permalink
allow customizing icon
Browse files Browse the repository at this point in the history
  • Loading branch information
Pavel Makhov committed Jul 23, 2021
1 parent c76e7dd commit 8432ac0
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,21 @@ When clicked it shows some information about the user:
</p>


## Themes
## Customizations

The app can be customized and use one of the following themes
When creating a spoon you can customize how it looks like by passing optional parameters descibed below.

### Icons

You can change default square icon to any character, like

circle ('●'): <img alt="classic" src="https://github.com/fork-my-spoons/github-contributions.spoon/raw/main/screenshots/circles.png">

star ('★'): <img alt="classic" src="https://github.com/fork-my-spoons/github-contributions.spoon/raw/main/screenshots/stars.png">

### Themes

You can also change colors of icons, by using one of the following color themes:

| theme name | screenshot |
|---|---|
Expand Down Expand Up @@ -55,7 +67,8 @@ The app can be customized and use one of the following themes
hs.loadSpoon("github-contributions")
spoon['github-contributions']:setup({
usernames = {'streetturtle', 'fork-my-spoons', 'mgubaidullin'}, -- use on or multiple accounts
-- theme = 'pink'
-- theme = 'pink',
-- char = '★'
})
spoon['github-contributions']:start()
```
Binary file added screenshots/circles.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/stars.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8432ac0

Please sign in to comment.