feat: init

Author: int64ago

README.TEMPLATE.md

@@ -0,0 +1,68 @@
+# react-hooks-<%= name %>
+
+[![NPM version][npm-image]][npm-url]
+[![npm download][download-image]][download-url]
+[![Build Status][travis-image]][travis-url]
+
+<%= desc %>
+
+## Install
+
+>**Note:** The Hooks isn't stable now, the stable version will be available on [Q1 of 2019](https://reactjs.org/blog/2018/11/27/react-16-roadmap.html).
+>
+>Make sure that you have installed the correct version of `react(>= v16.7.0-alpha)` and `react-dom(>= v16.7.0-alpha)`.
+
+### npm
+
+```bash
+npm install --save @use-hooks/<%= name %>
+```
+
+### yarn
+
+```bash
+yarn add @use-hooks/<%= name %>
+```
+
+## API
+
+### Params
+
+```js
+<%= params %>
+```
+
+### Returns
+
+```js
+<%= returns %>
+```
+
+## Usage
+
+```js
+<%- 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](https://github.com/use-hooks/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.org/use-hooks/react-hooks-<%= name %>
+ [travis-image]: https://img.shields.io/travis/use-hooks/react-hooks-<%= name %>.svg?style=flat-square

README.md

@@ -1,2 +1,3 @@
-# readme-generator
-Readme Generator
+# use-hooks-readme
+
+Readme Generator for Use Hooks

index.js

@@ -0,0 +1,41 @@
+#!/usr/bin/env node
+
+const { readFileSync, writeFileSync } = require('fs');
+const { join } = require('path');
+const { render } = require('ejs');
+
+const pkg = require(join(process.cwd(), 'package.json'));
+
+if (!/^@use-hooks\//.test(pkg.name)) {
+  console.error('ERROR: Only for @use-hooks packages.');
+  process.exit(0);
+}
+
+const jsdocRegex = /[ \t]*\/\*\*\s*\n([^*]*(\*[^/])?)*\*\//g;
+const sourceCode = readFileSync(join(process.cwd(), 'src/index.js'), 'utf8');
+
+const jsdocs = sourceCode.match(jsdocRegex);
+
+if (
+  !jsdocs
+  || jsdocs.length !== 2
+  || !jsdocs[0].includes('Params')
+  || !jsdocs[1].includes('Returns')
+) {
+  console.error('ERROR: Invalid format of JSDoc.');
+  process.exit(0);
+}
+
+const example = readFileSync(join(process.cwd(), 'example/App.jsx'), 'utf8');
+
+const readmeTpl = readFileSync(join(__dirname, 'README.TEMPLATE.md'), 'utf8');
+
+const readme = render(readmeTpl, {
+  name: pkg.name.split('/')[1],
+  desc: pkg.description,
+  params: jsdocs[0],
+  returns: jsdocs[1],
+  example: example.replace('../src', pkg.name),
+});
+
+writeFileSync(join(process.cwd(), 'README.md'), readme, 'utf8');

package.json

@@ -0,0 +1,24 @@
+{
+  "name": "use-hooks-readme",
+  "version": "1.0.0",
+  "description": "Readme Generator",
+  "main": "index.js",
+  "bin": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/use-hooks/readme-generator.git"
+  },
+  "keywords": [
+    "react",
+    "react-hooks"
+  ],
+  "author": "Cody Chan <int64ago@gmail.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/use-hooks/readme-generator/issues"
+  },
+  "homepage": "https://github.com/use-hooks/readme-generator#readme",
+  "dependencies": {
+    "ejs": "^2.6.1"
+  }
+}