Skip to content

Commit

Permalink
Readme tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
TfTHacker committed Nov 11, 2021
1 parent f7cb86b commit 9a00f00
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 11 deletions.
17 changes: 7 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,14 @@ Simply add the GitHub repository path for the beta Obsidian plugin to the list f
- Enable/Disable a plugin
- Little more explanation for those who like to read
- [Themes](/help/themes.md)
- Grab a beta theme from a repository
- Updata a beta theme from a repository
- Grab a community theme
- Switch Active Theme
- Switch active theme
- Settings for themes
- [Github](/help/github.md)
- Open a GitHub plugin repository
- Open a GitHub phemes repository
- [Logging](/help/logging.md)
- Logging Support
- [For developers](/help/developers.md)
- [For plugin developers](/help/developers.md)
- How Obsidian loads plugins
- manifest-beta.json
- How BRAT works
Expand Down Expand Up @@ -64,20 +61,20 @@ Simply add the GitHub repository path for the beta Obsidian plugin to the list f

## Themes
### Grab a beta theme from a repository
BRAT helps you to test themes currently under development. To use this feature:
- BRAT helps you to test themes currently under development. To use this feature:

1. Open the command palette and select the command **Grab a beta theme for testing from a Github repository**
2. You are then prompted for the url path to the github repository where the theme is stored

BRAT will then validate that a theme exists, download it and switch your current theme to this beta theme.
- BRAT will then validate that a theme exists, download it and switch your current theme to this beta theme.

Since this is a beta theme and does not yet have a community name, BRAT assigns it a unique name using "BRAT-" in the beginning and adding the name of the Github user and repository.
- Since this is a beta theme and does not yet have a community name, BRAT assigns it a unique name using "BRAT-" in the beginning and adding the name of the Github user and repository.

### Update a beta theme from a repository
Using the theme update command, Brat will check for all beta themese and see if there is an update. If there is an update, it downloads the update and notifies you.
- Using the theme update command, Brat will check for all beta themese and see if there is an update. If there is an update, it downloads the update and notifies you.

### Grab a community theme
While BRAT is designed for testing themes, you can still install a theme already published to the community. This theme wil not be updated with the BRAT update feature.
- While BRAT is designed for testing themes, you can still install a theme already published to the community. This theme wil not be updated with the BRAT update feature.

---

Expand Down
2 changes: 1 addition & 1 deletion help/themes.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Switch Active Theme
# Switch active theme
Switch quickly between any installed theme, whether it is a beta theme you installed from a repository or a theme from the community list.

# Settings for themes
Expand Down

0 comments on commit 9a00f00

Please sign in to comment.