@decidables/decidables-elements 0.0.4 → 0.2.0

package/README.md

@@ -1,9 +1,13 @@
 <!--lint ignore first-heading-level-->
 
-# decidables-elements: Basic UI Web Components for [**decidables**](https://github.com/decidables/decidables)
+# **`@decidables/decidables-elements`**<br>Web Components for Basic UI in [**decidables**](https://decidables.github.io)
 
 [![npm version](https://img.shields.io/npm/v/@decidables/decidables-elements?logo=npm)](https://www.npmjs.com/package/@decidables/decidables-elements)
-[![license](https://img.shields.io/npm/l/@decidables/decidables-elements)](https://github.com/decidables/decidables/blob/main/LICENSE.md)
+[![license](https://img.shields.io/npm/l/@decidables/decidables-elements?color=informational)](https://github.com/decidables/decidables/blob/main/LICENSE.md)
+
+This package provides basic user interface web components for use in all of the explorables. This
+facilitates a consistent look and feel. They try to use the native inputs when possible, but build
+on them for new elements like a switch, and composite elements like a slider with a linked spinner.
 
 ## Usage
 
@@ -267,7 +271,9 @@ static get properties() {
 
 And `this.stuff` will be a `Set` with members: `'this'`, `'that'`, and `'other'`
 
-## Features/Bugs/Notes
+## Development
+
+### Features/Bugs/Notes
 
 - Custom spinner that looks better than User Agent spinners?
 - Edge/IE11 - slider shadow is clipped
@@ -275,9 +281,7 @@ And `this.stuff` will be a `Set` with members: `'this'`, `'that'`, and `'other'`
 - Firefox - spinner arrows look ugly and asymmetrical
 - IE11 - No CSS variables outside custom elements (and not patched by ShadyCSS!)
 
-## Development Tooling
-
-### Local Scripts
+### Package Scripts
 
 - `yarn lint`
   - Lints markdown, scripts and styles
@@ -290,7 +294,7 @@ And `this.stuff` will be a `Set` with members: `'this'`, `'that'`, and `'other'`
 - `yarn build`
   - Builds bundles from `src/` to `lib/`
 
-## File Organization
+### File Organization
 
 - `decidables-elements/`
   - `lib/` (Bundles created from `src/` by `build`) **\[autogenerated\]**
@@ -298,6 +302,13 @@ And `this.stuff` will be a `Set` with members: `'this'`, `'that'`, and `'other'`
   - `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).