clean up

Author: OlivierJM

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 OlivierJM
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -13,15 +13,18 @@ npm install --save react-dynamic-fields
 ## Usage
 
 ```tsx
-import React, { Component } from 'react'
-
-import MyComponent from 'react-dynamic-fields'
-import 'react-dynamic-fields/dist/index.css'
-
-class Example extends Component {
-  render() {
-    return <MyComponent />
-  }
+import React from 'react'
+import SingleField from 'react-dynamic-fields'
+
+const App = () => {
+  const [options, setOptions] = React.useState([''])
+  return (
+    <SingleField
+      options={options}
+      setOptions={setOptions}
+      label='Types of fruits'
+    />
+  )
 }
 ```
 

example/README.md

@@ -1,5 +1 @@
-This example was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
-
-It is linked to the react-dynamic-fields package in the parent directory for development purposes.
-
-You can run `yarn install` and then `yarn start` to test your package.
+This is an example on how to make use of the react-dynamic-fields

example/src/App.tsx

@@ -1,7 +1,5 @@
 import React from 'react'
-
 import { SingleField } from 'react-dynamic-fields'
-import 'react-dynamic-fields/dist/index.css'
 
 const App = () => {
   const [options, setOptions] = React.useState([''])

src/index.test.tsx

@@ -1,7 +1,7 @@
-import { ExampleComponent } from '.'
+import { SingleField } from '.'
 
 describe('ExampleComponent', () => {
   it('is truthy', () => {
-    expect(ExampleComponent).toBeTruthy()
+    expect(SingleField).toBeTruthy()
   })
 })

src/index.tsx

@@ -1,9 +1,3 @@
-// import * as React from 'react'
-// import styles from './styles.module.css'
 import SingleField from './SingleField'
 
-// interface Props {
-//   text: string
-// }
-
 export { SingleField }