Merge pull request #96 from thepensionsregulator/all-pkg-docs

root docs updated

Author: d4lek

packages/core/README.md

@@ -1 +1,12 @@
-CORE COMPONENTS
+# @tpr/core [![npm version](https://flat.badgen.net/npm/v/@tpr/core)](https://www.npmjs.com/package/@tpr/core)
+
+Core components for TPR apps.
+
+## Installation
+
+```sh
+npm install @tpr/core
+
+# Peer Dependencies - Also Required
+npm install react react-dom @tpr/theming
+```

packages/forms/README.md

@@ -1,44 +1,28 @@
-# `@tpr/forms`
+# @tpr/forms [![npm version](https://flat.badgen.net/npm/v/@tpr/forms)](https://www.npmjs.com/package/@tpr/forms)
 
-Forms will adapt react-final-forms library and will expose helper functions to simplify form components delivery.
+Form components for TPR apps.
 
-## Form Functions
+## Installation
 
-### ✅ validate()
+```sh
+npm install @tpr/forms
 
-```ts
-validate(formFields: FieldProps[]) => (formValues) => errors object
+# Peer Dependencies - Also Required
+npm install react react-dom @tpr/theming
 ```
 
-### ✅ renderFields()
+## Helpers
 
-```ts
-renderFields(fields: FieldProps[]): ReactElement
-```
-
-## Form Components
-
-### ✅ Text
-
-- should have a label
-- label should have a state if it is an optional input
-- should take custom validation function
-- should have a 100% or custom width option
-
-### ✅ Radio Buttons Group
-
-- if 2 options than should display as row list
-- if 3 or more options should display in column list
-- config to be able to select a number of options
-
-### ✅ Checkbox
-
-### ✅ Select + Search
-
-- should have a dropdown with ability to select a single option
-- shoult take onSelect handler
+- `validate: (fields: FieldProps[]) => (formValues) => errors object`: validate function helper for `react-final-form` Form component.
+- `renderFields: (fields: FieldProps[]) => ReactElement[]`: renders a vertical list of fields from the fields array. Has to be used as a child of Form component.
 
-### ✅ Textarea
+## Components
 
-- should have max length prop
-- should show chars left when typing
+- Checkbox
+- Date
+- Hidden input
+- Input
+- Number
+- Radio
+- Select
+- Text

packages/icons/README.md

@@ -1,3 +1,12 @@
-# `@tpr/icons`
+# @tpr/icons [![npm version](https://flat.badgen.net/npm/v/@tpr/icons)](https://www.npmjs.com/package/@tpr/icons)
 
-> TODO: description
+Icon components for TPR apps.
+
+## Installation
+
+```sh
+npm install @tpr/icons
+
+# Peer Dependencies - Also Required
+npm install react react-dom @tpr/theming
+```

packages/layout/README.md

@@ -1 +1,12 @@
-LAYOUT COMPONENTS
+# @tpr/layout [![npm version](https://flat.badgen.net/npm/v/@tpr/layout)](https://www.npmjs.com/package/@tpr/layout)
+
+Layout components for TPR apps.
+
+## Installation
+
+```sh
+npm install @tpr/layout
+
+# Peer Dependencies - Also Required
+npm install react react-dom @tpr/theming
+```