Readme Updates

xylabs · Oct 13, 2023 · e69b47a · e69b47a
1 parent 0c19409
commit e69b47a
Show file tree

Hide file tree

Showing 29 changed files with 602 additions and 1,230 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -40,6 +40,8 @@
     "adword",
     "Adwords",
     "appbar",
+    "Arie",
+    "arietrouw",
     "autodocs",
     "awid",
     "bignumber",
@@ -48,10 +50,12 @@
     "ethersproject",
     "flexbox",
     "instrumenter",
+    "jsdelivr",
     "Merkle",
     "noindex",
     "reinit",
     "Tiktok",
+    "Trouw",
     "typedoc",
     "webp",
     "xylabs",

diff --git a/README.md b/README.md
@@ -4,6 +4,9 @@
 
 [![main-build][]][main-build-link]
 [![npm-badge][]][npm-link]
+[![npm-downloads-badge][]][npm-link]
+[![jsdelivr-badge][]][jsdelivr-link]
+[![npm-license-badge][]](LICENSE)
 [![codacy-badge][]][codacy-link]
 [![codeclimate-badge][]][codeclimate-link]
 [![snyk-badge][]][snyk-link]
@@ -21,7 +24,7 @@
 
 ## Description
 
-Common React code that is used throughtout XYO projects that use React.
+Common React code that is used throughout XYO projects that use React.
 
 Features:
 
@@ -45,10 +48,24 @@ Using yarn:
 yarn add @xylabs/sdk-react
 ```
 
+## Documentation
+[Developer Reference](https://xylabs.github.io/sdk-react)
+
+[Storybook](https://xylabs.github.io/sdk-react/storybook)
+
 ## Scripts
 
-See [ts-scripts-yarn3](https://github.com/xylabs/ts-scripts-yarn3/blob/main/README.md) for
-list of shared scripts. The below scripts are custom scripts for this repo.
+Using npm:
+
+```sh
+npm xy --help
+```
+
+Using yarn:
+
+```sh
+yarn xy --help
+```
 
 ### Build (Storybook)
 
@@ -68,7 +85,10 @@ yarn start
 
 ## Maintainers
 
--   [Arie Trouw](https://github.com/arietrouw) [arietrouw.com](https://arietrouw.com)
+- [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
+- [Matt Jones](https://github.com/jonesmac)
+- [Joel Carter](https://github.com/JoelBCarter)
+- [Jordan Trouw](https://github.com/jordantrouw)
 
 ## License
 
@@ -94,3 +114,9 @@ See the [LICENSE](LICENSE) file for license details
 
 [snyk-badge]: https://snyk.io/test/github/xylabs/sdk-react/badge.svg?targetFile=package.json
 [snyk-link]: https://snyk.io/test/github/xylabs/sdk-react?targetFile=package.json
+
+[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/react-shared
+[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/react-shared
+
+[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/react-shared/badge
+[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/react-shared
diff --git a/packages/accordion/README.md b/packages/accordion/README.md
@@ -0,0 +1,67 @@
+[![logo][]](https://xylabs.com)
+
+# @xylabs/react-accordion
+
+[![npm-badge][]][npm-link]
+[![npm-downloads-badge][]][npm-link]
+[![jsdelivr-badge][]][jsdelivr-link]
+[![npm-license-badge][]](LICENSE)
+
+> XY Labs generalized React library 
+
+## Table of Contents
+
+-   [Description](#description)
+-   [Install](#install)
+-   [Maintainers](#maintainers)
+-   [License](#license)
+-   [Credits](#credits)
+
+## Description
+
+Common React code that is used throughout XYO projects that use React.
+
+## Install
+
+Using npm:
+
+```sh
+npm i --save @xylabs/react-accordion
+```
+
+Using yarn:
+
+```sh
+yarn add @xylabs/react-accordion
+```
+
+## Documentation
+[Developer Reference](https://xylabs.github.io/sdk-react)
+
+[Storybook](https://xylabs.github.io/sdk-react/storybook)
+
+## Maintainers
+
+- [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
+- [Matt Jones](https://github.com/jonesmac)
+- [Joel Carter](https://github.com/JoelBCarter)
+- [Jordan Trouw](https://github.com/jordantrouw)
+
+## License
+
+See the [LICENSE](LICENSE) file for license details
+
+## Credits
+
+[Made with 🔥and ❄️ by XY Labs](https://xylabs.com)
+
+[logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
+
+[npm-badge]: https://img.shields.io/npm/v/@xylabs/react-accordion.svg
+[npm-link]: https://www.npmjs.com/package/@xylabs/react-accordion
+
+[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/react-accordion
+[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/react-accordion
+
+[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/react-accordion/badge
+[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/react-accordion
diff --git a/packages/appbar/README.md b/packages/appbar/README.md
@@ -1,68 +1,51 @@
 [![logo][]](https://xylabs.com)
 
-# @xylabs/sdk-react
+# @xylabs/react-appbar
 
-[![main-build][]][main-build-link]
-[![beta-build][]][beta-build-link]
 [![npm-badge][]][npm-link]
-[![bch-badge][]][bch-link]
-[![codacy-badge][]][codacy-link]
-[![codeclimate-badge][]][codeclimate-link]
-[![snyk-badge][]][snyk-link]
+[![npm-downloads-badge][]][npm-link]
+[![jsdelivr-badge][]][jsdelivr-link]
+[![npm-license-badge][]](LICENSE)
 
 > XY Labs generalized React library 
 
 ## Table of Contents
 
 -   [Description](#description)
 -   [Install](#install)
--   [Scripts](#scripts)
 -   [Maintainers](#maintainers)
 -   [License](#license)
 -   [Credits](#credits)
 
 ## Description
 
-Common React code that is used throughtout XYO projects that use React.
+Common React code that is used throughout XYO projects that use React.
 
 ## Install
 
 Using npm:
 
 ```sh
-npm i --save @xylabs/sdk-react
+npm i --save @xylabs/react-appbar
 ```
 
 Using yarn:
 
 ```sh
-yarn add @xylabs/sdk-react
+yarn add @xylabs/react-appbar
 ```
 
-## Scripts
+## Documentation
+[Developer Reference](https://xylabs.github.io/sdk-react)
 
-See [ts-scripts-yarn3](https://github.com/xylabs/ts-scripts-yarn3/blob/main/README.md) for
-list of shared scripts. The below scripts are custom scripts for this repo.
-
-### Build (Storybook)
-
-Build the static Storybook site
-
-```sh
-yarn build-storybook
-```
-
-### Start
-
-Starts the project in the browser for testing, with auto reload using Storybook
-
-```sh
-yarn start
-```
+[Storybook](https://xylabs.github.io/sdk-react/storybook)
 
 ## Maintainers
 
--   [Arie Trouw](https://github.com/arietrouw) [arietrouw.com](https://arietrouw.com)
+- [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
+- [Matt Jones](https://github.com/jonesmac)
+- [Joel Carter](https://github.com/JoelBCarter)
+- [Jordan Trouw](https://github.com/jordantrouw)
 
 ## License
 
@@ -74,23 +57,11 @@ See the [LICENSE](LICENSE) file for license details
 
 [logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
 
-[main-build]: https://github.com/xylabs/sdk-react/actions/workflows/build-main.yml/badge.svg
-[main-build-link]: https://github.com/xylabs/sdk-react/actions/workflows/build-main.yml
-
-[beta-build]: https://github.com/xylabs/sdk-react/actions/workflows/build-beta.yml/badge.svg
-[beta-build-link]: https://github.com/xylabs/sdk-react/actions/workflows/build-beta.yml
-
-[npm-badge]: https://img.shields.io/npm/v/@xylabs/sdk-react.svg
-[npm-link]: https://www.npmjs.com/package/@xylabs/sdk-react
-
-[bch-badge]: https://bettercodehub.com/edge/badge/xylabs/sdk-react?branch=main
-[bch-link]: https://bettercodehub.com/results/xylabs/sdk-react
-
-[codacy-badge]: https://app.codacy.com/project/badge/Grade/c2a69d4530ed4b7da6ddb070169dd339
-[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-react/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-react&utm_campaign=Badge_Grade
+[npm-badge]: https://img.shields.io/npm/v/@xylabs/react-appbar.svg
+[npm-link]: https://www.npmjs.com/package/@xylabs/react-appbar
 
-[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c461e0bc2b00c0b01ac0/maintainability
-[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-react/maintainability
+[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/react-appbar
+[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/react-appbar
 
-[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-react/badge.svg?targetFile=package.json
-[snyk-link]: https://snyk.io/test/github/xylabs/sdk-react?targetFile=package.json
+[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/react-appbar/badge
+[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/react-appbar
diff --git a/packages/async-effect/README.md b/packages/async-effect/README.md
@@ -1,68 +1,51 @@
 [![logo][]](https://xylabs.com)
 
-# @xylabs/sdk-react
+# @xylabs/react-async-effect
 
-[![main-build][]][main-build-link]
-[![beta-build][]][beta-build-link]
 [![npm-badge][]][npm-link]
-[![bch-badge][]][bch-link]
-[![codacy-badge][]][codacy-link]
-[![codeclimate-badge][]][codeclimate-link]
-[![snyk-badge][]][snyk-link]
+[![npm-downloads-badge][]][npm-link]
+[![jsdelivr-badge][]][jsdelivr-link]
+[![npm-license-badge][]](LICENSE)
 
 > XY Labs generalized React library 
 
 ## Table of Contents
 
 -   [Description](#description)
 -   [Install](#install)
--   [Scripts](#scripts)
 -   [Maintainers](#maintainers)
 -   [License](#license)
 -   [Credits](#credits)
 
 ## Description
 
-Common React code that is used throughtout XYO projects that use React.
+Common React code that is used throughout XYO projects that use React.
 
 ## Install
 
 Using npm:
 
 ```sh
-npm i --save @xylabs/sdk-react
+npm i --save @xylabs/react-async-effect
 ```
 
 Using yarn:
 
 ```sh
-yarn add @xylabs/sdk-react
+yarn add @xylabs/react-async-effect
 ```
 
-## Scripts
+## Documentation
+[Developer Reference](https://xylabs.github.io/sdk-react)
 
-See [ts-scripts-yarn3](https://github.com/xylabs/ts-scripts-yarn3/blob/main/README.md) for
-list of shared scripts. The below scripts are custom scripts for this repo.
-
-### Build (Storybook)
-
-Build the static Storybook site
-
-```sh
-yarn build-storybook
-```
-
-### Start
-
-Starts the project in the browser for testing, with auto reload using Storybook
-
-```sh
-yarn start
-```
+[Storybook](https://xylabs.github.io/sdk-react/storybook)
 
 ## Maintainers
 
--   [Arie Trouw](https://github.com/arietrouw) [arietrouw.com](https://arietrouw.com)
+- [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
+- [Matt Jones](https://github.com/jonesmac)
+- [Joel Carter](https://github.com/JoelBCarter)
+- [Jordan Trouw](https://github.com/jordantrouw)
 
 ## License
 
@@ -74,23 +57,11 @@ See the [LICENSE](LICENSE) file for license details
 
 [logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
 
-[main-build]: https://github.com/xylabs/sdk-react/actions/workflows/build-main.yml/badge.svg
-[main-build-link]: https://github.com/xylabs/sdk-react/actions/workflows/build-main.yml
-
-[beta-build]: https://github.com/xylabs/sdk-react/actions/workflows/build-beta.yml/badge.svg
-[beta-build-link]: https://github.com/xylabs/sdk-react/actions/workflows/build-beta.yml
-
-[npm-badge]: https://img.shields.io/npm/v/@xylabs/sdk-react.svg
-[npm-link]: https://www.npmjs.com/package/@xylabs/sdk-react
-
-[bch-badge]: https://bettercodehub.com/edge/badge/xylabs/sdk-react?branch=main
-[bch-link]: https://bettercodehub.com/results/xylabs/sdk-react
-
-[codacy-badge]: https://app.codacy.com/project/badge/Grade/c2a69d4530ed4b7da6ddb070169dd339
-[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-react/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-react&utm_campaign=Badge_Grade
+[npm-badge]: https://img.shields.io/npm/v/@xylabs/react-async-effect.svg
+[npm-link]: https://www.npmjs.com/package/@xylabs/react-async-effect
 
-[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c461e0bc2b00c0b01ac0/maintainability
-[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-react/maintainability
+[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/react-async-effect
+[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/react-async-effect
 
-[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-react/badge.svg?targetFile=package.json
-[snyk-link]: https://snyk.io/test/github/xylabs/sdk-react?targetFile=package.json
+[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/react-async-effect/badge
+[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/react-async-effect