update docs

Signed-off-by: danieloprado <[email protected]>

Author: danieloprado

API.md renamed to HOW_TO_USE.md

@@ -1,5 +1,4 @@
-API
----
+# How To Use
 
 ### Base (Common props)
 
@@ -25,6 +24,7 @@ interface IState extends IStateFieldBase {
 
 interface IProps extends IPropsFieldBase {
   // your props
+  onChange: (value: string) => void;
 }
 
 class MyComponentField extends FieldCoreBase<IProps, IState> {
@@ -64,4 +64,47 @@ class MyComponentField extends FieldCoreBase<IProps, IState> {
     );
   }
 }
+```
+
+### How extends default config
+
+```ts
+// your config/index.ts
+import * as coreConfig from '@react-form-fields/core/config';
+
+declare module '@react-form-fields/core/config' {
+  interface IConfig {
+    newProps?: string;
+  }
+}
+
+const defaultConfig: coreConfig.IConfig = {
+  newProps: 'teste'
+};
+
+export function getConfig(): coreConfig.IConfig {
+  return {
+    ...defaultConfig,
+    ...(coreConfig.getConfig() || {})
+  };
+}
+
+export function setConfig(config: coreConfig.IConfig) {
+  coreConfig.setConfig(config);
+}
+
+// your config/builder.ts
+import { IConfig } from '@react-form-fields/core/config';
+import CoreConfigBuilder from '@react-form-fields/core/config/builder';
+
+export default class ConfigBuilder extends CoreConfigBuilder {
+  public setNewProps(newProps: string) {
+    this.config = {
+      ...this.config,
+      newProps: newProps
+    };
+
+    return this; // <-- always return this
+  }
+}
 ```

README.md

@@ -2,7 +2,6 @@
 React Form Fields: Core
 ------------------------------
 
-See [API.md](https://github.com/react-form-fields/core/blob/master/API.md) for details
 
 ## Requirements 
 
@@ -21,55 +20,7 @@ yarn add @react-form-fields/core
 
 ### How to Create a Form Field
 
-```tsx
-import FieldCoreBase, { IPropsFieldBase, IStateFieldBase } from '@react-form-fields/core/components/FieldCoreBase';
-
-interface IState extends IStateFieldBase {
-  //your state props
-}
-
-interface IProps extends IPropsFieldBase {
-  // your props
-}
-
-class MyComponentField extends FieldCoreBase<IProps, IState> {
-  //If you need getDerivedStateFromProps dont forget to call super 
-  static getDerivedStateFromProps(props: IProps, currentState: IState): IState {
-    const state = super.getDerivedStateFromProps(props, currentState);
-    // your logic....
-    return state;
-  }
-
-  onChange = event => {
-    const value = this.mask.clean(event.target ? event.target.value : event);
-
-    this.setState({ touched: true }); //<-- important to show the error
-    this.props.onChange(value);
-  }
-
-  render() {
-    const { label, name } = this.props;
-
-    return (
-      <Fragment>
-        {/* import: register the field in the validation context */}
-        <ValidationContextRegister field={this} />
-
-        {/* isRequired: check if validation prop contains the required rule */}
-        <label>{label} {this.isRequired ? '*' : ''}</label>
-        <input 
-          name={name}
-          value={this.getMaskedValue}
-          onChange={this.onChange}
-        />
-
-        {/* errorMessage will be null if submitted and touched are false  */}
-        {this.errorMessage ? <p class="error">{this.errorMessage}</p> : null}
-      </Fragment>
-    );
-  }
-}
-```
+See [HOW_TO_USE.md](https://github.com/react-form-fields/core/blob/master/HOW_TO_USE.md) for details
 
 ### Common Masks