Readme

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rhazn/logic-components",
-    "version": "0.0.2",
+    "version": "0.0.3",
     "description": "Framework agnostic components to implement logic tools",
     "private": false,
     "main": "dist/index.cjs.js",

readme.md

@@ -1,12 +1,17 @@
 # Logic components
 
-[![DOI](https://zenodo.org/badge/365273738.svg)](https://zenodo.org/badge/latestdoi/365273738)
+logic-components aims to provide a library with common interface elements to implement tools in belief change research. Components are implemented as [HTML Custom Elements](https://html.spec.whatwg.org/multipage/custom-elements.html#custom-elements) and therefore framework agnostic and work in a [wide variety of browsers](https://caniuse.com/custom-elementsv1).
 
-![Built With Stencil](https://img.shields.io/badge/-Built%20With%20Stencil-16161d.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDE5LjIuMSwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCA1MTIgNTEyOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI%2BCjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI%2BCgkuc3Qwe2ZpbGw6I0ZGRkZGRjt9Cjwvc3R5bGU%2BCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00MjQuNywzNzMuOWMwLDM3LjYtNTUuMSw2OC42LTkyLjcsNjguNkgxODAuNGMtMzcuOSwwLTkyLjctMzAuNy05Mi43LTY4LjZ2LTMuNmgzMzYuOVYzNzMuOXoiLz4KPHBhdGggY2xhc3M9InN0MCIgZD0iTTQyNC43LDI5Mi4xSDE4MC40Yy0zNy42LDAtOTIuNy0zMS05Mi43LTY4LjZ2LTMuNkgzMzJjMzcuNiwwLDkyLjcsMzEsOTIuNyw2OC42VjI5Mi4xeiIvPgo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNDI0LjcsMTQxLjdIODcuN3YtMy42YzAtMzcuNiw1NC44LTY4LjYsOTIuNy02OC42SDMzMmMzNy45LDAsOTIuNywzMC43LDkyLjcsNjguNlYxNDEuN3oiLz4KPC9zdmc%2BCg%3D%3D&colorA=16161d&style=flat-square)
+## Documentation
+Components are found in the `src/components` directory. A readme.md file is generated for every component in it's folder.
 
-## Description
+## Usage
+logic-components is available on npm: `npm i @rhazn/logic-components`
+(https://www.npmjs.com/package/@rhazn/logic-components).
 
-Framework agnostic components to implement logic tools
+A sibling repository for exposing the components as react components is available here: https://github.com/rhazn/logic-components-react.
 
-## Build locally with react components
+If you use logic-components you can cite it using [![DOI](https://zenodo.org/badge/365273738.svg)](https://zenodo.org/badge/latestdoi/365273738)
+
+### Other
 - `npm run build && cd ../logic-components-react && npm run build && cd -`

src/components/show-signature/show-signature.tsx

@@ -12,7 +12,7 @@ export class ShowSignature {
     render() {
         return (
             <Host>
-                <div>&sum;: {`{${[...this.signature].map(character => `${character}`)}}`}</div>
+                <div>&sum; = {`{${[...this.signature].map(character => `${character}`)}}`}</div>
             </Host>
         );
     }