Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
DexerBR committed Mar 9, 2022
1 parent b1d87c9 commit f062494
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

The effect created is based on the widget passed in as the background. You can control the blur size, saturation, luminosity, overlay color, noise opacity, border radius and the outline (color and width).

![](https://github.com/kivy-garden/frostedglass/blob/develop/doc/images/example_1.png?raw=true)
![](https://github.com/kivy-garden/frostedglass/blob/develop/doc/images/example_2.gif?raw=true)
![](https://github.com/kivy-garden/frostedglass/blob/main/doc/images/example_1.png?raw=true)
![](https://github.com/kivy-garden/frostedglass/blob/main/doc/images/example_2.gif?raw=true)

[![Github Build Status](https://github.com/kivy-garden/frostedglass/workflows/Garden%20flower/badge.svg)](https://github.com/kivy-garden/frostedglass/actions)
[![PyPI](https://img.shields.io/pypi/v/kivy_garden.frostedglass?)](https://pypi.org/project/kivy-garden.frostedglass/)
Expand All @@ -22,7 +22,7 @@ The effect created is based on the widget passed in as the background. You can c

## Example:

<img src="https://github.com/kivy-garden/frostedglass/blob/develop/doc/images/kivy_example.png?raw=true">
<img src="https://github.com/kivy-garden/frostedglass/blob/main/doc/images/kivy_example.png?raw=true">

```kvlang
Image:
Expand Down Expand Up @@ -50,15 +50,15 @@ FrostedGlass:
color: 'black'
font_size: dp(25)
```
### You can find more usage examples in the 🔷[examples folder](https://github.com/kivy-garden/frostedglass/tree/develop/examples)🔷
### You can find more usage examples in the 🔷[examples folder](https://github.com/kivy-garden/frostedglass/tree/main/examples)🔷

---

## Overview of *FrostedGlass* creation process

To reach the final result of the FrostedGlass widget, the steps described in the image below are followed:

![](https://github.com/kivy-garden/frostedglass/blob/develop/doc/images/FrostedgGlass_overview.png?raw=true)
![](https://github.com/kivy-garden/frostedglass/blob/main/doc/images/FrostedgGlass_overview.png?raw=true)

---

Expand Down
2 changes: 1 addition & 1 deletion examples/README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ In terms of performance, there is no significant difference between the first an

The main intention is to give a basic idea of how to combine FrostedGlass with the rest of the UI. These are just some of the many possible combinations you can make. *The creativity is yours!*

An FPS meter (`fps_monitor.py`) will also be imported and used to display the current performance of the UI. But attention, its use is indicated only for development purposes and contribution to the FrostedGlass project widget. For final product uses, perform conventional import and use as described on the project homepage: [*Import and Usage*](https://github.com/kivy-garden/frostedglass/blob/develop/README.md#import)
An FPS meter (`fps_monitor.py`) will also be imported and used to display the current performance of the UI. But attention, its use is indicated only for development purposes and contribution to the FrostedGlass project widget. For final product uses, perform conventional import and use as described on the project homepage: [*Import and Usage*](https://github.com/kivy-garden/frostedglass/blob/main/README.md#import)

### For contributors:

Expand Down

0 comments on commit f062494

Please sign in to comment.