@record-evolution/widget-value 1.1.23 → 1.1.25

package/README.md

@@ -5,22 +5,25 @@ This webcomponent follows the [open-wc](https://github.com/open-wc/open-wc) reco
 ## Installation
 
 ```bash
-npm i widget-value
+npm i @record-evolution/widget-value
 ```
 
 ## Usage
 
 ```html
 <script type="module">
-  import 'widget-value/widget-value.js';
+    import '@record-evolution/widget-value/widget-value.js'
 </script>
 
-<widget-value></widget-value>
+<widget-value-1.1.24></widget-value-1.1.24>
 ```
 
 ## Expected data format
 
+Please take a look at the src/default-data.json to see what data is expected to make the widget show content.
+
 The following format represents the available data :
+
 ```js
 data: {
   settings: {
@@ -38,64 +41,7 @@ data: {
 }
 ```
 
-## Interfaces
-
-```ts
-  interface InputData {
-    settings: Settings
-    gaugeValue: number
-  }
-```
-```ts
-  interface Settings {
-    title: string,
-    subTitle: string,
-    minGauge: number,
-    maxGauge: number,
-    style: Style
-  }
-```
-```ts
-  interface Style {
-    needleColor: string,
-    sections: number,
-    backgroundColor: string[]
-  }
-```
-
-## Style options
-The following options are available for styling the value graph.
-The `sections` option splits the value area into by default three same sized sections. Therefore three different colors can be provided to the `backgroundColor` by default.
-```
-  interface Style {
-    needleColor: string,
-    sections: number,
-    backgroundColor: string[]
-  }
-```
-
-## Linting and formatting
-
-To scan the project for linting and formatting errors, run
-
-```bash
-npm run lint
-```
-
-To automatically fix linting and formatting errors, run
-
-```bash
-npm run format
-```
-
-
-## Tooling configs
-
-For most of the tools, the configuration is in the `package.json` to reduce the amount of files in your project.
-
-If you customize the configuration a lot, you can consider moving them to individual files.
-
-## Local Demo with `web-dev-server`
+## Local Demo
 
 ```bash
 npm start