Skip to content

Commit

Permalink
docs(next-tinacms-json): reformats helper interface and explanation
Browse files Browse the repository at this point in the history
  • Loading branch information
kendallstrautman committed Aug 3, 2020
1 parent 536c532 commit e018eb0
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions packages/next-tinacms-json/README.md
Expand Up @@ -10,10 +10,16 @@ yarn add next-tinacms-json

## Helpers

- `useJsonForm( jsonFile, options? ):[values, form]`: A React Hook that creates a Git form
- `jsonForm( Component, options? ): Component`: An HOC that creates and registers a Git form
- `useLocalJsonForm`(deprecated)
- `useGlobalJsonForm`(deprecated)
```ts
useJsonForm( jsonFile, options? ):[values, form]
```
`useJsonForm` is a [React Hook](https://reactjs.org/docs/hooks-intro.html) that creates a Git form
```ts
jsonForm( Component, options? ): Component
```
`jsonForm` is a [React Higher-Order Component](https://reactjs.org/docs/higher-order-components.html) that creates and registers a Git form
### _useJsonForm_ hook
Expand Down

0 comments on commit e018eb0

Please sign in to comment.