From 247c4546918238205d2f20b4cbc581022416f5d0 Mon Sep 17 00:00:00 2001 From: exetico Date: Tue, 2 Jan 2024 14:14:08 +0100 Subject: [PATCH] Move README.md to root and use in HACS --- .github/README.md | 88 --------------------------------------------- README.md | 91 +++++++++++++++++++++++++++++++++++++++++++++-- hacs.json | 5 +-- info.md | 45 ----------------------- 4 files changed, 91 insertions(+), 138 deletions(-) delete mode 100644 .github/README.md delete mode 100644 info.md diff --git a/.github/README.md b/.github/README.md deleted file mode 100644 index 3a8e4676..00000000 --- a/.github/README.md +++ /dev/null @@ -1,88 +0,0 @@ -

- -
-
- HA Floorplan -

- - -

Floorplan for Home Assistant - your imagination (almost) defines the limits

- -

- - GitHub Last commit - - - GitHub Issues - - - GitHub Pull Requests - - - GitHub Stars - - - Current version - - - HACS Default repository - Go to Quick Start in Docs - -

- -

- • - Floorplan Documentation • - Discussion (Ask for help, feedback & support) • - Home Assistant Community • -

- -
- -
- -[![See it in action](https://user-images.githubusercontent.com/3549445/293683054-a110a5fe-72d3-4004-970b-1e07159e5577.png)](https://experiencelovelace.github.io/ha-floorplan/docs/example-floorplanner-home/) - -## Draw it and bring it to life - -This tool expands way beyond creating just floorplans. If you can draw it in an SVG file, you can bring it to life with ha-floorplan. Explore endless possibilities and customize your home automation experience to your liking. - -## Getting started - -We'll suggest you to visit our [Installation](https://experiencelovelace.github.io/ha-floorplan/docs/quick-start/) guide. - -If you're unsure on where to start in the creation process, we'll suggest you to check our [Live Examples](https://experiencelovelace.github.io/ha-floorplan/docs/examples/). - -Find more documentation on how to use each action and functions, by visiting the [Usage](https://experiencelovelace.github.io/ha-floorplan/docs/usage/) page. - - -## Features - -- Make Floorplan(s) with SVG-files -- Trigger states, visualize states and more -- Call services and more, for even more options -- Use as Lovelace-card, or as a panel -- _It's hard to mention everything in a list like this, so **give it a try**_ 🥳 - - -
-
- - - - - -
-
- -Would you like to play around with the code behind HA Floorplan? _There's many ways to build HA Floorplan. The question is, what you're going to do?_ - -Just execute `npm install` to install the dependencies. Use `npm run build` for the production-env. Are you going to test something, use `npm run build:dev` instead. For other options, check [package.json](https://github.com/ExperienceLovelace/ha-floorplan/blob/master/package.json). - -
-
\ No newline at end of file diff --git a/README.md b/README.md index 17324c07..ced66e0a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,90 @@ -# ha-floorplan +

+ +
+
+ ha-floorplan +

-![Preview](https://user-images.githubusercontent.com/3549445/293683054-a110a5fe-72d3-4004-970b-1e07159e5577.png) -SVG Preview \ No newline at end of file +

Floorplan for Home Assistant - your imagination (almost) defines the limits

+ +

+ + GitHub Last commit + + + GitHub Issues + + + GitHub Pull Requests + + + GitHub Stars + + + Current version + + + HACS Default repository - Go to Quick Start in Docs + +

+ +

+ • + Floorplan Documentation • + Discussion (Ask for help, feedback & support) • + Home Assistant Community • +

+ +
+ + + +SVG Preview + + +## Draw it and bring it to life + +This tool expands way beyond creating just floorplans. If you can draw it in an SVG file, you can bring it to life with ha-floorplan. Explore endless possibilities and customize your home automation experience to your liking. + +## Getting started + +We'll suggest you to visit our [Installation](https://experiencelovelace.github.io/ha-floorplan/docs/quick-start/) guide. + +If you're unsure on where to start in the creation process, we'll suggest you to check our [Live Examples](https://experiencelovelace.github.io/ha-floorplan/docs/examples/). + +Find more documentation on how to use each action and functions, by visiting the [Usage](https://experiencelovelace.github.io/ha-floorplan/docs/usage/) page. + + +## Features + +- Make Floorplan(s) with SVG-files +- Trigger states, visualize states and more +- Call services and more, for even more options +- Use as Lovelace-card, or as a panel +- _It's hard to mention everything in a list like this, so **give it a try**_ 🥳 + +
+ +
+
+ + + + + +
+
+ +Would you like to play around with the code behind HA Floorplan? _There's many ways to build HA Floorplan. The question is, what you're going to do?_ + +Just execute `npm install` to install the dependencies. Use `npm run build` for the production-env. Are you going to test something, use `npm run build:dev` instead. For other options, check [package.json](https://github.com/ExperienceLovelace/ha-floorplan/blob/master/package.json). + +
+
\ No newline at end of file diff --git a/hacs.json b/hacs.json index 64cb134c..5c8151f3 100644 --- a/hacs.json +++ b/hacs.json @@ -1,4 +1,5 @@ { "name": "ha-floorplan 🖌🎨 - Your imagination just become the new limit", - "filename": "floorplan.js" -} + "filename": "floorplan.js", + "render_readme": true +} \ No newline at end of file diff --git a/info.md b/info.md deleted file mode 100644 index ca8d865f..00000000 --- a/info.md +++ /dev/null @@ -1,45 +0,0 @@ -{% if prerelease %} -

ATTENTION: This is a pre-version of HA Floorplan!

-{% endif %} - -HA Floorplan Logo - -# HA Floorplan - -**Floorplan for Home Assistant - your imagination (almost) defines the limits** - -
- -
- -
- -### 📚 Read the documentation 📚 - -You'll find information about: -- Installation -- Usage -- Examples -- _And more..._ - - -### Features - -- Make Floorplan(s) with SVG-files -- Trigger states, visualize states and more -- Call services and more, for even more options -- Use as Lovelace-card, or as a panel -- _It's hard to mention everything in a list like this, so **give it a try**_ 🥳 - -SVG Preview - -
- - -#### Ressource template for Home Assistant - -```yaml -resources: - - url: /hacsfiles/ha-floorplan/floorplan.js - type: module -``` \ No newline at end of file