docs(use-double-tap): Add proper README.md and LICENSE.md files

Author: minwork

packages/use-double-tap/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019-present Krzysztof Kalkhoff
+
+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.

packages/use-double-tap/README.md

@@ -1,7 +1,95 @@
-# use-double-tap
+# :point_up_2: React Double Tap Hook :point_up_2:
 
-This library was generated with [Nx](https://nx.dev).
+> React hook for handling double tap on mobile devices
 
-## Running unit tests
+![Travis (.org)](https://img.shields.io/travis/minwork/use-double-tap)
+![Codecov](https://img.shields.io/codecov/c/gh/minwork/use-double-tap)
+![npm type definitions](https://img.shields.io/npm/types/use-double-tap)
+![npm bundle size](https://img.shields.io/bundlephobia/min/use-double-tap)
+![npm](https://img.shields.io/npm/v/use-double-tap)
+![GitHub](https://img.shields.io/github/license/minwork/use-double-tap)
+## Install
 
-Run `nx test use-double-tap` to execute the unit tests via [Vitest](https://vitest.dev/).
+```bash
+npm install --save use-double-tap
+```
+or
+```bash
+yarn add use-double-tap
+```
+
+## Basic Usage
+
+```javascript
+import React from 'react';
+
+import { useDoubleTap } from 'use-double-tap';
+
+const Example = () => {
+    const bind = useDoubleTap((event) => {
+      // Your action here
+      console.log('Double tapped');
+    });
+
+    return <button {...bind}>Tap me</button>;
+}
+
+export default Example;
+```
+
+**[Live demo](https://codesandbox.io/s/usedoubletap-d2exl)**
+
+## Advanced usage
+### Custom capture threshold
+You can also manually specify time threshold for capturing double tap event (default: 300ms).
+```javascript
+useDoubleTap(() => {
+  // Your action here
+}, 500);
+```
+In the example above, second tap must occur within 500ms period to register double tap.
+
+### Additional options
+Supplied as third argument.
+```typescript
+useDoubleTap(() => {
+  // Actions on double tap
+}, 300, {
+  // Options here
+})
+```
+
+List of possible options:
+
+| Option        | Type            | Description  |
+| ------------- |:---------------:| -----|
+| onSingleTap   | Function | Callback for handling case when double tap is not triggered,<br> because of capture timeout.<br><br>For example if `threshold` parameter is *300ms* and second tap occurs after *400ms*<br> then `onSingleTap` is triggered **after** capture interval (*300ms*) expires. |
+
+### Disable event binding
+If you pass falsy value as callback (like `null`) double tap will not bind to the component.
+```javascript
+useDoubleTap(null);
+```
+This allows you to dynamically control if event should be bound. For example:
+
+```javascript
+const bind = useDoubleTap(isMobile ? () => {
+  console.log('Double tapped');
+} : null);
+```
+
+## :warning: Warning
+This hook internally use `onClick` event to detect double tap, so be careful not to override your existing event listener.
+
+This is where disabling listener binding may come handy - you can use double tap detection only when necessary.
+
+## Why `onClick`?
+Because it leverages built in event listener which can also detect mobile tap event.
+
+This way we can get rid of complicated edge cases when combining `onTouchStart onTouchEnd onTouchCancel onTouchMove` events.
+
+Also this approach greatly reduce package size as well as increase speed and flexibility.
+
+## License
+
+MIT © [minwork](https://github.com/minwork)