@decidables/detectable-elements 0.0.3 → 0.1.2

package/README.md

@@ -1,9 +1,14 @@
-<!--lint ignore first-heading-level-->
+<!--lint ignore first-heading-level  maximum-heading-length-->
 
-# detectable-elements: Web Components for Visualizing Signal Detection Theory
+# **`@decidables/detectable-elements`**<br>Web Components for Visualizing Signal Detection Theory in [<b><i>d′</i>ete<i>c</i>table</b>](https://decidables.github.io/detectable)
 
 [![npm version](https://img.shields.io/npm/v/@decidables/detectable-elements?logo=npm)](https://www.npmjs.com/package/@decidables/detectable-elements)
-[![license](https://img.shields.io/npm/l/@decidables/detectable-elements)](https://github.com/decidables/decidables/blob/main/LICENSE.md)
+[![license](https://img.shields.io/npm/l/@decidables/detectable-elements?color=informational)](https://github.com/decidables/decidables/blob/main/LICENSE.md)
+
+The web components used to visualize Signal Detection Theory in
+[<b><i>d′</i>ete<i>c</i>table</b>](https://decidables.github.io/detectable). There is an emphasis on
+direct manipulation and consistent use of color. SVG is used extensively to provide clean scalable
+diagrams.
 
 ## Usage
 
@@ -1177,7 +1182,9 @@ export default class DetectableElementSomething extends DetectableElement {
 
 `DetectableElement` extends `DecidableElement` extends `LitElement`
 
-## Features/Bugs/Notes
+## Development
+
+### Features/Bugs/Notes
 
 - Remove extraneous spaces from equation tagged template literals!
 - Label values IN iso-plots? or allow hover or click querying of iso-plots?
@@ -1187,9 +1194,7 @@ export default class DetectableElementSomething extends DetectableElement {
 - Edge/IE11 - minor edge defects between SVG element and shadow
 - Firefox - No CSS SVG Geometry Properties
 
-## Development Tooling
-
-### Local Scripts
+### Package Scripts
 
 - `yarn lint`
   - Lints scripts in `src/`
@@ -1202,7 +1207,7 @@ export default class DetectableElementSomething extends DetectableElement {
 - `yarn build`
   - Builds browser-compatible optimized bundle from `src/` to `lib/`
 
-## File Organization
+### File Organization
 
 - `detectable-elements/`
   - `lib/` (Bundles created from `src/` by `build`) **\[autogenerated\]**
@@ -1213,6 +1218,13 @@ export default class DetectableElementSomething extends DetectableElement {
   - `test/` (Testing files)
     - `coverage/` (Code coverage results) **\[autogenerated\]**
   - `CHANGELOG.md` (Based on conventional commits) **\[autogenerated\]**
-  - `gulpfile.js` (Config for *gulp*)
-  - `package.json` (Config for *yarn* and *npm*)
+  - `gulpfile.js` (Tasks for *gulp*)
+  - `package.json` (Package config for *yarn* and *npm*)
   - `README.md` (This file)
+
+## [License](https://github.com/decidables/decidables/blob/main/LICENSE.md)
+
+The content of this project is licensed under [Creative Commons Attribution-ShareAlike 4.0
+International License (CC-BY-SA-4.0)](https://creativecommons.org/licenses/by-sa/4.0/) and the
+source code of this project is licensed under [GNU General Public License v3.0 or any later version
+(GPL-3.0-or-later)](https://www.gnu.org/licenses/gpl-3.0.html).