Skip to content

Commit

Permalink
readme 🧾
Browse files Browse the repository at this point in the history
  • Loading branch information
nor0x committed Sep 13, 2022
1 parent e839f81 commit 49bb4cb
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,8 @@ a simple control to display scrolling overflow content!

| Platform | Support |
| :-------------: |:-------------:|
| Android ||
| iOS ||
| UWP||
| Xamarin.Forms ||
| .NET MAUI ||

## Getting started

Expand All @@ -37,7 +36,7 @@ Start by adding a the XAML namespace `xmlns:over="clr-namespace:OverFlower;asse
## API

### `ImageSource`
is a regular Xamarin.Forms ImageSource and
is a regular .NET MAUI / Xamarin.Forms ImageSource and
### `ImageWidth`
width of the overflow image
### `ImageHeight`
Expand All @@ -47,11 +46,11 @@ scrolling direction of the overflow image
### `ScrollDuration`
duration of the scrolling operation (in milliseconds)
### `Reverse`
coming soon™️

toggle if animation should run indefinitely or reverse after reaching the end

## Demo

SampleMaui includes a playground & demo of the control
<img src="https://raw.githubusercontent.com/nor0x/OverFlower/main/imgs/demo.png" />

## Contribution
feel free to create issues and PRs 👋
Binary file added imgs/demo.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 49bb4cb

Please sign in to comment.