Skip to content

Commit

Permalink
docs(README.md): improve install and usage instructions (#1090)
Browse files Browse the repository at this point in the history
  • Loading branch information
uncenter authored Jul 19, 2024
1 parent 6975e59 commit 89c3e2a
Showing 1 changed file with 15 additions and 12 deletions.
27 changes: 15 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,25 +48,28 @@ Install [Stylus](https://github.com/openstyles/stylus) for your browser by click
> [!TIP]
> If you use Chrome, make sure to enable "Allow access to file URLs" in the Stylus extension settings.
### All Userstyles
### All Userstyles (recommended)

See instructions on the [GitHub release page](https://github.com/catppuccin/userstyles/releases/tag/all-userstyles-export).

### Individual Userstyles

1. Enable CSP Patching from `Stylus Settings` > `Advanced`.
2. Install the theme:
- `https://github.com/catppuccin/userstyles/raw/main/styles/<name>/catppuccin.user.css`
- Replacing `<name>` with the name of the userstyle.
1. Enable CSP Patching from Stylus's **Settings** > **Advanced**.
2. Install userstyles by clicking the **Stylus Install** badge in each README.
3. Enjoy!

> [!TIP]
> For decentralized or self-hosted applications, you can apply a theme to one or multiple instances across updates by following the instructions below.
>
> 1. Open the Stylus "Manage" page.
> 2. Click on the userstyle's name in the list.
> 3. Click on **Style settings** in the left panel.
> 4. Enter the URL patterns for your instance(s) in the text box labeled **Custom included sites**.
## Usage

All usertyles come with three default configuration options; the light flavor, the dark flavor, and the accent color. Some userstyles may offer additional site-specific options as well.

### Decentralized/self-hosted applications

For decentralized or self-hosted applications, you can apply a theme to one or multiple instances across updates by following the instructions below.

1. Open the Stylus "Manage" page.
2. Click on the userstyle's name in the list.
3. Click on **Style settings** in the left panel.
4. Enter the URL patterns for your instance(s) in the text box labeled **Custom included sites**. For example, to apply a userstyle to `example.org`, you would add a line with `https://example.org/*` to the textbox. The trailing asterisk applies it to all pages on the domain - without it, only the root page is themed.

&nbsp;

Expand Down

0 comments on commit 89c3e2a

Please sign in to comment.