From 1ac575d7acc2fc05fe4c234d7baf61d365183adf Mon Sep 17 00:00:00 2001
From: Ryan Meek <25127328+maykar@users.noreply.github.com>
Date: Mon, 3 Aug 2020 13:27:02 -0400
Subject: [PATCH] Update README.md
---
README.md | 36 ++++++++++++------------------------
1 file changed, 12 insertions(+), 24 deletions(-)
diff --git a/README.md b/README.md
index 55587fb..a864ef9 100644
--- a/README.md
+++ b/README.md
@@ -19,49 +19,36 @@ Swipe through Lovelace views on mobile.
# Installation:
Follow only one of these installation methods.
+
+ Installation and tracking with HACS:
+
+1. In "store" search for lovelace-swipe-navigation and install.
+
+2. Refresh the Lovelace page.
+
+
Manual installation:
1. Copy `swipe-navigation.js` into `/www/lovelace-swipe-navigation/`
-2. Add the resource in `ui-lovelace.yaml` or by using the "Raw Config Editor".
+2. Add the resource in `ui-lovelace.yaml` or in Lovelace Resources.
```yaml
resources:
# increase this version number at end of URL after each update
- url: /local/lovelace-swipe-navigation/swipe-navigation.js?v=1.0.0
- type: js
+ type: module
```
3. Refresh the page.
-
- Installation and tracking with HACS:
-
-1. In "store" search for lovelace-swipe-navigation and install.
-
-2. Configure Lovelace to load the card:
-
-```yaml
-resources:
- - url: /community_plugin/lovelace-swipe-navigation/swipe-navigation.js
- type: js
-```
-
-3. Refresh the Lovelace page.
-
-
-
# Config:
Configuration is done in the root of your lovelace configuration.
Example:
```yaml
-resources:
- - url: /local/lovelace-swipe-navigation/swipe-navigation.js?v=1.0.0
- type: js
-
swipe_nav:
wrap: false
animate: swipe
@@ -78,9 +65,10 @@ views:
| ---- | ---- | ------- | -----------
| swipe_amount | number | 15 | Minimum percent of screen needed to be swiped in order to navigate.
| skip_tabs | string | | A comma seperated list of views to skip when swiping. e.g., `1,3,5`.
+| skip_hidden | boolean | true | Automatically skips hidden tabs.
| wrap | boolean | true | Wrap from first tab to last tab and vice versa.
| prevent_default | boolean | false | Prevents the browsers default horizontal swipe actions.
-| animate | string | no animation | Swipe animations. Can be: `swipe`, `fade`, `flip`.
+| animate | string | no animation | Swipe animations. Can be: `swipe`, `fade`, `flip`. The swipe animation should be considered experimental and depending on your setup may appear buggy.
# Thank you
Big thanks to: