Merge pull request #94 from dbuezas/feat-restructure-repo

chore: restructure the repository to conform with home assistant standards

.vscode/settings.json

@@ -12,7 +12,6 @@
     },
     "[python]": {
         "editor.defaultFormatter": "charliermarsh.ruff",
-        "lint"
     },
     "python.analysis.autoImportCompletions": true,
     "python.analysis.packageIndexDepths": [
@@ -34,6 +33,7 @@
         "**/.mypy_cache": true,
         "**/.pytest_cache": true,
         "**/.ruff_cache": true,
+        "**/dist": true,
     },
     "extensions.ignoreRecommendations": false
 }

LICENSE.md

@@ -0,0 +1,31 @@
+Copyright 2024 David Buezas, Lennard Beers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+------------------------------- Other Licenses -------------------------------
+
+The MIT License (MIT)
+
+Copyright (c) 2016 Markus Peter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -22,13 +22,13 @@ A modernized temporary replacement for the native Home Assistant component.
 4. Click `Add`
 5. Close `Custom Repositories` modal
 6. Click `+ EXPLORE & DOWNLOAD REPOSITORIES`
-7. Search for `dbuezas_eq3btsmart`
+7. Search for `eq3btsmart`
 8. Click `Download`
 9. Restart _Home Assistant_
 
 ### Option 2: Manual copy
 
-1. Copy the `dbuezas_eq3btsmart` folder inside `custom_components` of this repo to `/config/custom_components` in your Home Assistant instance
+1. Copy the `eq3btsmart` folder inside `custom_components` of this repo to `/config/custom_components` in your Home Assistant instance
 2. Restart _Home Assistant_
 
 ## Adding devices
@@ -40,7 +40,7 @@ A modernized temporary replacement for the native Home Assistant component.
 
 <img width="290" alt="image" src="https://user-images.githubusercontent.com/777196/204042753-6d08d4b2-d220-4d9b-9fd9-35ca57b5acc9.png">​
 
-or click `+ ADD INTEGRATION` and search for `dbuezas_eq3btsmart`
+or click `+ ADD INTEGRATION` and search for `eq3btsmart`
 
 <img width="290" alt="image" src="https://user-images.githubusercontent.com/777196/204042799-548a382f-6220-4d9f-a8e8-748ecc0de105.png">