doc(readme) add missing readme (#11)

* doc(readme) add readme and npm command line
AxaFrance · Nov 29, 2018 · 46d1a89 · 46d1a89
1 parent 4ca6390
commit 46d1a89
Show file tree

Hide file tree

Showing 90 changed files with 447 additions and 983 deletions.
diff --git a/README.md b/README.md
diff --git a/packages/Form/Input/card/README.md b/packages/Form/Input/card/README.md
@@ -0,0 +1,8 @@
+## Form Input Card
+
+### Get started
+
+```sh
+npm i @axa-fr/react-toolkit-form-input-card
+```
+
diff --git a/packages/Form/Input/checkbox/README.md b/packages/Form/Input/checkbox/README.md
@@ -0,0 +1,8 @@
+## Form Input Checkbox
+
+### Get started
+
+```sh
+npm i @axa-fr/react-toolkit-form-input-checkbox
+```
+
diff --git a/packages/Form/Input/choice/README.md b/packages/Form/Input/choice/README.md
@@ -0,0 +1,8 @@
+## Form Input Choice
+
+### Get started
+
+```sh
+npm i @axa-fr/react-toolkit-form-input-choice
+```
+
diff --git a/packages/Form/Input/date/README.md b/packages/Form/Input/date/README.md
@@ -1,11 +1,17 @@
-## CustomDate
+## Form Input Date
 * * *
 
 ### Get started
+
+```sh
+npm i @axa-fr/react-toolkit-form-input-date
+```
+
+
 First to use, you have to import the component.
 
 ```js
-import {CustomDate} from 'af-toolkit-react';
+import {CustomDate} from '@axa-fr/react-toolkit-form-input-date';
 ```
 
 The component reuses the following library:

diff --git a/packages/Form/Input/file/README.md b/packages/Form/Input/file/README.md
@@ -0,0 +1,8 @@
+## Form Input Date
+
+### Get started
+
+```sh
+npm i @axa-fr/react-toolkit-form-input-file
+```
+
diff --git a/packages/Form/Input/number/README.md b/packages/Form/Input/number/README.md
@@ -0,0 +1,8 @@
+## Form Input Number
+
+### Get started
+
+```sh
+npm i @axa-fr/react-toolkit-form-input-number
+```
+
diff --git a/packages/Form/Input/pass/README.md b/packages/Form/Input/pass/README.md
@@ -0,0 +1,8 @@
+## Form Input Pass
+
+### Get started
+
+```sh
+npm i @axa-fr/react-toolkit-form-input-pass
+```
+
diff --git a/packages/Form/Input/radio/README.md b/packages/Form/Input/radio/README.md
@@ -0,0 +1,8 @@
+## Form Input Radio
+
+### Get started
+
+```sh
+npm i @axa-fr/react-toolkit-form-input-radio
+```
+
diff --git a/packages/Form/Input/select-multi/README.md b/packages/Form/Input/select-multi/README.md
@@ -0,0 +1,8 @@
+## Form Input SelectMulti
+
+### Get started
+
+```sh
+npm i @axa-fr/react-toolkit-form-input-select-multi
+```
+
diff --git a/packages/Form/Input/select/README.md b/packages/Form/Input/select/README.md
@@ -0,0 +1,8 @@
+## Form Input Select
+
+### Get started
+
+```sh
+npm i @axa-fr/react-toolkit-form-input-select
+```
+
diff --git a/packages/Form/Input/slider/README.md b/packages/Form/Input/slider/README.md
@@ -0,0 +1,8 @@
+## Form Input Slider
+
+### Get started
+
+```sh
+npm i @axa-fr/react-toolkit-form-input-slider
+```
+
diff --git a/packages/Form/Input/switch/README.md b/packages/Form/Input/switch/README.md
@@ -1,84 +1,7 @@
-## SwitchInput
-* * *
+## Form Input Switch
 
 ### Get started
-First to use, you have to import the component.
 
-
-
-This story show you the Action Button case.
-This isn't a link but a button where you can catch the event to do what you want.
-
-For more information about style component, you can see the [Action Button Style on Toolkit-core ](http://toolkit-intranet-axa.azurewebsites.net/#/button)
-
-
-### Accessibility
-
-By default, it is better to use the button tag because it contains all accessibility properties.
-
-You may need to use other HTML tags or need to handle actions on events.
-
-In this case, you will need to add several properties to your tag:
-
-<table aria-labelledby="rps_label" class="af-table data attributes">
-      <thead class="af-table__head">
-        <tr class="af-table__tr">
-          <th class="af-table__th" scope="col">Role</th>
-          <th class="af-table__th" scope="col">Attribute</th>
-          <th class="af-table__th" scope="col">Element</th>
-          <th class="af-table__th" scope="col">Usage</th>
-        </tr>
-      </thead>
-      <tbody class="af-table__body">
-        <tr class="af-table__tr">
-          <td class="af-table__cell"><code>button</code></td>
-          <td class="af-table__cell"></td>
-          <td class="af-table__cell">
-            <code>div</code>, <code>a</code>
-          </td>
-          <td class="af-table__cell">
-            <ul>
-              <li>Identifies the element as a <code>button</code> widget.</li>
-              <li> Accessible name for the button is defined by the text content of the element.</li>
-            </ul>
-          </td>
-        </tr>
-        <tr class="af-table__tr">
-          <td class="af-table__cell"></td>
-          <td class="af-table__cell">
-            <code>tabindex="0"</code>
-          </td>
-          <td class="af-table__cell">
-            <code>div</code>, <code>a</code>
-          </td>
-          <td class="af-table__cell">
-            <ul>
-              <li>Includes the element in the tab sequence.</li>
-              <li>Needed on the <code>a</code> element because it does not have a <code>href</code> attribute.</li>
-            </ul>
-          </td>
-        </tr>
-        <tr class="af-table__tr">
-          <td class="af-table__cell"></td>
-          <td class="af-table__cell"><code>aria-pressed="false"</code></td>
-          <td class="af-table__cell"><code>a</code></td>
-          <td class="af-table__cell">
-            <ul>
-              <li>Identifies the button as a toggle button.</li>
-              <li>Indicates the toggle button is not pressed.</li>
-            </ul>
-          </td>
-        </tr>
-        <tr class="af-table__tr">
-          <td class="af-table__cell"></td>
-          <td class="af-table__cell"><code>aria-pressed="true"</code></td>
-          <td class="af-table__cell"><code>a</code></td>
-          <td class="af-table__cell">
-            <ul>
-              <li>Identifies the button as a toggle button.</li>
-              <li>Indicates the toggle button is pressed.</li>
-            </ul>
-          </td>
-        </tr>
-      </tbody>
-    </table>
+```sh
+npm i @axa-fr/react-toolkit-form-input-switch
+```
diff --git a/packages/Form/Input/text/README.md b/packages/Form/Input/text/README.md
@@ -0,0 +1,8 @@
+## Form Input Text
+
+### Get started
+
+```sh
+npm i @axa-fr/react-toolkit-form-input-text
+```
+
diff --git a/packages/Form/Input/textarea/README.md b/packages/Form/Input/textarea/README.md
@@ -0,0 +1,8 @@
+## Form Input TextArea
+
+### Get started
+
+```sh
+npm i @axa-fr/react-toolkit-form-input-textarea
+```
+
diff --git a/packages/Form/core/README.md b/packages/Form/core/README.md
@@ -0,0 +1,8 @@
+## Form Filter
+
+### Get started
+
+```sh
+npm i @axa-fr/react-toolkit-form-core
+```
+
diff --git a/packages/Form/filter-inline/README.md b/packages/Form/filter-inline/README.md
@@ -0,0 +1,8 @@
+## Filter Inline
+
+### Get started
+
+```sh
+npm i @axa-fr/react-toolkit-form-filter-inline
+```
+
diff --git a/packages/Form/filter/README.md b/packages/Form/filter/README.md
@@ -0,0 +1,8 @@
+## Form Filter
+
+### Get started
+
+```sh
+npm i @axa-fr/react-toolkit-form-filter
+```
+
diff --git a/packages/Form/steps/README.md b/packages/Form/steps/README.md
@@ -0,0 +1,8 @@
+## Form Steps
+
+### Get started
+
+```sh
+npm i @axa-fr/react-toolkit-form-steps
+```
+
diff --git a/packages/Form/summary/README.md b/packages/Form/summary/README.md
@@ -0,0 +1,8 @@
+## Form Summary
+
+### Get started
+
+```sh
+npm i @axa-fr/react-toolkit-form-summary
+```
+
diff --git a/packages/Layout/footer-client/README.md b/packages/Layout/footer-client/README.md
@@ -0,0 +1,7 @@
+## FooterClient
+
+### Get started
+
+```sh
+  npm i "@axa-fr/react-toolkit-layout-footer-client"
+```
diff --git a/packages/Modal/boolean/README.md b/packages/Modal/boolean/README.md
@@ -0,0 +1,8 @@
+## Modal Boolean
+
+### Get started
+
+```sh
+npm i @axa-fr/react-toolkit-modal-boolean
+```
+
diff --git a/packages/Modal/default/README.md b/packages/Modal/default/README.md
@@ -1,9 +1,9 @@
-## Simple badge
+## Modal Default
 
 ### Get started
 
 ```sh
-npm i "@axa-fr/react-toolkit-modal"
+npm i "@axa-fr/react-toolkit-modal-default"
 ```
 
 For more information about style component, you can see the [Modal Style on Toolkit-core ](http://toolkit-intranet-axa.azurewebsites.net/#/modal)
@@ -14,7 +14,7 @@ For more information about style component, you can see the [Modal Style on Tool
 import React from 'react';
 import Modal from '@axa-fr/react-toolkit-modal';
 
-const MyModal => () => {
+const MyModal => () => (
  <Modal
   classModifier={text('classModifier', '')}
   className={text('className', '')}
@@ -44,6 +44,6 @@ const MyModal => () => {
   </button>
   </Modal.Footer>
 </Modal>
-}
+)
 ```
 
diff --git a/packages/action/README.md b/packages/action/README.md
@@ -6,7 +6,7 @@
 npm i @axa-fr/react-toolkit-action
 ```
 
-### Diffrence entre Action et ActionCore
+### Difference between Action and ActionCore
 
 Action :
 
@@ -21,32 +21,32 @@ onCick : React.MouseEventHandler<HTMLAnchorElement>;
 ```
 
 
-### Exemple Action
+### Sample Action
 
 ```javascript
 import React from 'react';
 import Action from '@axa-fr/react-toolkit-action';
 
-const MyAlertComponent => () => {
+const MyAlertComponent => () => (
 <Action
     classModifier="MyModifier"
     icon="ok"
     title="Les caves et les garages situés dans le même corps de bâtiment que le logement assuré sont garantis d′office"
   />
-}
+)
 ```
 
-### Exemple ActionCore
+### Sample ActionCore
 
 ```javascript
 import React from 'react';
 import {ActionCore} from '@axa-fr/react-toolkit-action';
 
-const MyAlertComponent => () => {
+const MyAlertComponent => () => (
 <Action
     classModifier="MyModifier"
     icon="ok"
     title="Les caves et les garages situés dans le même corps de bâtiment que le logement assuré sont garantis d′office"
   />
-}
+)
 ```
diff --git a/packages/all/README.md b/packages/all/README.md
@@ -0,0 +1,10 @@
+## All
+
+### Get started
+
+```sh
+npm i "@axa-fr/react-toolkit-all"
+```
+
+Reference every "react-toolkit" modules
+
diff --git a/packages/badge/README.md b/packages/badge/README.md
@@ -1,4 +1,4 @@
-## Simple badge
+## Badge
 
 ### Get started
 
@@ -8,15 +8,15 @@ npm i "@axa-fr/react-toolkit-badge"
 
 For more information about style component, you can see the [Badge Style on Toolkit-core ](http://toolkit-intranet-axa.azurewebsites.net/#/badge)
 
-### Exemple
+### Sample
 
 ```javascript
 import React from 'react';
 import Action from '@axa-fr/react-toolkit-badge';
 
-const MyAlertComponent => () => {
+const MyBadgeComponent => () => (
 <Badge classModifier="success">
   Lorem ipsum
 </Badge>
-}
+)
 ```