Skip to content

Commit

Permalink
Update README to fix issue #1 (#4)
Browse files Browse the repository at this point in the history
* Remove theme table

* Update cover photo

* Update README nad cover pic name reference

* Remove non-default theme pics

* Update README with theme links and clearer text

* Update README to include Contributing section
  • Loading branch information
trevor-moon authored Oct 27, 2021
1 parent 63eb759 commit 52a6c3d
Show file tree
Hide file tree
Showing 7 changed files with 36 additions and 14 deletions.
50 changes: 36 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The minimal dark theme inspired by [Material Theme][material-web] for [Vivaldi][vivaldi] web browser.

![default-themes](assets/material-defaults.png "default themes")
![default-themes][material-cover]

> [Material][material], [Material Darker][material-darker], [Material Deep Ocean][material-deepocean], [Material Palenight][material-palenight], [Material Lighter][material-lighter]
Expand All @@ -18,13 +18,15 @@ The minimal dark theme inspired by [Material Theme][material-web] for [Vivaldi][
3. Click the `+` and enter a name (e.g., Material)
4. Copy the theme's `.json` values to the Vivaldi theme

For example, if I want the traditional Material theme, use the colors from [material.json](material.json)
For example, if I want the traditional [Material][material-json] theme:

- Background: `#263238`
- Foreground: `#b0bec5`
- Highlight: `#546e7a`
- Accent: `#546e7a`

See [Themes](#themes) for the available Material Theme color palettes.

See [Colors](#colors) for recommended Vivaldi-Material color/setting combinations.

### Automatic
Expand All @@ -33,11 +35,19 @@ See [Colors](#colors) for recommended Vivaldi-Material color/setting combination

*If you have ideas how to automatically generate/update/sync Vivaldi themes, please see [Contributing](#contributing). I would love to have this feature.*

## Colors
## Themes

The Vivaldi themes are created from the color palettes found [here][material-theme-colors].

- [Material][material-json]
- [Material Darker][material-darker-json]
- [Material Deep Ocean][material-deepocean-json]
- [Material Palenight][material-palenight-json]
- [Material Lighter][material-lighter-json]

The material theme colors were obtained from [material-theme.com](material-theme-colors).
### Colors

I like to use the following theme values for the Vivaldi settings.
I like to use the following theme colors for the Vivaldi theme settings.
| Vivaldi Setting | Default | Alternate | Colorful |
|-----------------|------------|--------------|--------------|
| Background | background | background | background |
Expand All @@ -49,22 +59,34 @@ I like to use the following theme values for the Vivaldi settings.
If you like a **pop of color** in your theme, I would use the *Alternate* or *Colorful* suggestions.

| Theme | Recommended | Colorful |
|--------------------|------------------------------------|---------------------------------------------|
| Material | ![material-png][material-png] | ![material-accent-png][material-accent-png] |
| Material Darker | ![](assets/material-darker.png) | ![](assets/material-darker-accent.png) |
| Material DeepOcean | ![](assets/material-deepocean.png) | ![](assets/material-deepocean-accent.png) |
| Material Lighter | ![](assets/material-lighter.png) | ![](assets/material-lighter-accent.png) |
| Material Palenight | ![](assets/material-palenight.png) | ![](assets/material-palenight-accent.png) |
## Contributing

If you would like to contribute to this project, feel free to

- [submit a bug][create-issue]
- [create an issue][create-issue]
- [request a feature][create-issue]
- [fork this repo][fork-repo]
- [create a pull-request][create-pull-request]

Please [email me][email] if you have any other questions or feedback!

<!-- links -->
[vivaldi]: https://vivaldi.com
[material-web]: https://material-theme.site
[material-theme-colors]: https://material-theme.com/docs/reference/color-palette/
[material-png]: assets/material.png
[material-accent-png]: assets/material-accent.png
[material-cover]: assets/material-defaults.png
[material]: assets/material.png
[material-darker]: assets/material-darker.png
[material-deepocean]: assets/material-deepocean.png
[material-lighter]: assets/material-lighter.png
[material-palenight]: assets/material-palenight.png
[material-json]: material.json
[material-darker-json]: material-darker.json
[material-deepocean-json]: material-deepocean.json
[material-palenight-json]: material-palenight.json
[material-lighter-json]: material-lighter.json
[create-issue]: https://github.com/trevor-moon/material-vivaldi/issues
[fork-repo]: https://github.com/trevor-moon/material-vivaldi/fork
[create-pull-request]: https://github.com/trevor-moon/material-vivaldi/pulls
[email]: mailto:[email protected]
Binary file removed assets/material-accent.png
Binary file not shown.
Binary file removed assets/material-darker-accent.png
Binary file not shown.
Binary file removed assets/material-deepocean-accent.png
Binary file not shown.
Binary file modified assets/material-defaults.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 removed assets/material-lighter-accent.png
Binary file not shown.
Binary file removed assets/material-palenight-accent.png
Binary file not shown.

0 comments on commit 52a6c3d

Please sign in to comment.