Skip to content

Latest commit

 

History

History
66 lines (43 loc) · 1.27 KB

README.TEMPLATE.md

File metadata and controls

66 lines (43 loc) · 1.27 KB

react-hooks-<%- name %>

[![NPM version][npm-image]][npm-url] [![npm download][download-image]][download-url] [![Build Status][travis-image]][travis-url]

<%- desc %>

Install

Note: Make sure that you have installed the correct version of react(>= v16.8.0) and react-dom(>= v16.8.0).

npm

npm install --save @use-hooks/<%- name %>

yarn

yarn add @use-hooks/<%- name %>

API

Params

<%- params %>

Returns

<%- returns %>

Usage

<%- example %>

[Live Show](https://use-hooks.github.io/react-hooks-<%- name %>/)

Development

Node >= v8 LTS

  • Clone the project to local disk
  • npm install
  • npm start

License

MIT

Generated by create-react-hooks.

[npm-image]: https://img.shields.io/npm/v/@use-hooks/<%- name %>.svg?style=flat-square [npm-url]: https://npmjs.org/package/@use-hooks/<%- name %> [download-image]: https://img.shields.io/npm/dm/@use-hooks/<%- name %>.svg?style=flat-square [download-url]: https://npmjs.org/package/@use-hooks/<%- name %> [travis-url]: https://travis-ci.com/use-hooks/react-hooks-<%- name %> [travis-image]: https://img.shields.io/travis/com/use-hooks/react-hooks-<%- name %>.svg?style=flat-square