Update README.md

This commit is contained in:
htmltiger 2021-12-30 03:22:46 +00:00 committed by GitHub
parent d758104609
commit 6721d9c9e6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -6,25 +6,22 @@ Automaticly searches for `*.yaml` in the root and subfolders and lists in the dr
![screenshot](https://github.com/htmltiger/config-editor-card/raw/main/screenshot.png)
To create a new file choose the first blank in dropdown menu and type some text and hit Save
Please backup your files before using as there is no undo.
## Installation
### Step 1
You will also need to install a custom component https://github.com/htmltiger/config-editor
* **Manual**
Download and copy `config_editor` directory in `custom_components`
* **[HACS](https://hacs.xyz/)**
Integration > `Config Editor`
* **Manual**
Download and copy `config_editor` directory in `custom_components`
Restart home assistant.
Edit configuration.yaml and add the following so it can load
@ -34,31 +31,19 @@ config_editor:
Restart home assistant.
### Step 2
* **[HACS](https://hacs.xyz/)**
Frontend > `Config Editor Card`
* **Manual**
add config-editor-card.js to your `<config>/www/` folder
add url `/local/config-editor-card.js?v=1` from Configuration -> Lovelace Dashboards -> Resources panel when not using YAML mode
for YAML mode add the following to the `configuration.yaml` file:
```yaml
lovelace:
resources:
- url: /local/config-editor-card.js?v=1
type: module
```
* **[HACS](https://hacs.xyz/)**
Frontend > `Config Editor Card`
add this (if in YAML mode):
```yaml
lovelace:
resources:
- url: /hacsfiles/config-editor-card/config-editor-card.js
type: module
```
## Add in the sidebar
@ -70,4 +55,12 @@ create a new tab in panel mode and add the card
type: custom:config-editor-card
```
It is also possible to add this using `+ Add Card` UI and choose `Custom: Config Editor Card`
#### To create a new file
choose the first blank in dropdown menu and type some text and hit Save
Please backup your files before using as there is no undo.