docs: add docs

Author: jquense

.github/workflows/deploy-docs.yml

@@ -0,0 +1,20 @@
+name: Deploy Documentation
+on:
+  push:
+    branches:
+      - master
+jobs:
+  build_docs:
+    name: Build and Deploy Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checking out Repository
+        uses: actions/checkout@v1
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+      - name: Install Dependencies
+        run: yarn bootstrap
+      - name: Build and Deploy Production Files
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: yarn deploy-docs

.github/workflows/test.yml

@@ -0,0 +1,29 @@
+name: Run Tests
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  test:
+    name: Run Testing Suite
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checking out Repository
+        uses: actions/checkout@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 12.x
+      - name: Install Dependencies
+        run: yarn bootstrap
+      - name: Run Tests
+        run: yarn test
+      - name: Build Project
+        run: yarn build
+      - name: Upload Test Coverage to CodeCov
+        uses: codecov/[email protected]
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

.travis.yml

@@ -18,10 +18,12 @@
   },
   "homepage": "https://github.com/react-restart/hooks#readme",
   "scripts": {
+    "bootstrap": "yarn && yarn --cwd www",
     "test": "jest --coverage",
     "tdd": "jest --watch",
     "build:pick": "cherry-pick --name=@restart/hooks --cwd=lib --input-dir=../src --cjs-dir=cjs --esm-dir=esm",
     "build": "rimraf lib && 4c build src && yarn build:pick",
+    "deploy-docs": "yarn --cwd www build --prefix-paths && gh-pages -d www/public",
     "prepublishOnly": "yarn build"
   },
   "jest": {
@@ -65,6 +67,7 @@
     "enzyme": "^3.10.0",
     "enzyme-adapter-react-16": "^1.15.1",
     "eslint": "^6.7.0",
+    "gh-pages": "^2.2.0",
     "husky": "^4.2.3",
     "jest": "^25.1.0",
     "lint-staged": "^10.0.8",

package.json

@@ -49,7 +49,7 @@ export class ObservableSet<V> extends Set<V> {
  *
  * @param init initial Set values
  */
-function useSet<V>(init?: Iterable<V>) {
+function useSet<V>(init?: Iterable<V>): ObservableSet<V> {
   const forceUpdate = useForceUpdate()
   return useStableMemo(() => new ObservableSet<V>(forceUpdate, init), [])
 }

src/useBreakpoint.tsx renamed to src/useBreakpoint.ts

@@ -11,7 +11,7 @@ module.exports = {
       options: {
         sources: [`${__dirname}/../src`],
         getImportName(docNode) {
-          return `import { ${docNode.name} } from '${docNode.packageName}'`
+          return `import ${docNode.name} from '${docNode.packageName}/${docNode.name}'`
         },
       },
     },

src/useSet.ts

@@ -7,7 +7,7 @@
     "build": "gatsby build"
   },
   "dependencies": {
-    "@docpocalypse/gatsby-theme": "^0.11.24",
+    "@docpocalypse/gatsby-theme": "^0.11.25",
     "gatsby": "^2.21.24",
     "gatsby-plugin-typedoc": "^0.3.11",
     "react": "^16.13.1",

www/gatsby-config.js

@@ -1 +1,17 @@
 # Getting Started
+
+`@restart/hooks` is a utility library of React hooks. There is a hook for almost any use case.
+Try them all!
+
+## Installation
+
+Install via your favorite package manager:
+
+```sh
+npm install @restart/hooks
+```
+
+## Usage
+
+Check out the indivudal API docs for each hook for descriptions of what it does and
+how to use it.

www/package.json

@@ -1226,10 +1226,10 @@
   optionalDependencies:
     fibers "^5.0.0"
 
-"@docpocalypse/gatsby-theme@^0.11.24":
-  version "0.11.24"
-  resolved "https://registry.yarnpkg.com/@docpocalypse/gatsby-theme/-/gatsby-theme-0.11.24.tgz#7c11df19f572c45177fe88f6f4ceb265bb631167"
-  integrity sha512-Q//H4vEVAVD6miyfZcyoMH5TBKMWu9CDFW2DOyGlgucF76LaIm3USf4aNwB2xdEgvLHGdav9CiEvCTC7j3tg0Q==
+"@docpocalypse/gatsby-theme@^0.11.25":
+  version "0.11.25"
+  resolved "https://registry.yarnpkg.com/@docpocalypse/gatsby-theme/-/gatsby-theme-0.11.25.tgz#2a4fb4517cef3d6c66fc91e3ca6cf753f680574f"
+  integrity sha512-olyXoPP7ABMqQCNA1xD1psSPrV6n3v3XIwuqJ7CDwQme/miCUifrIjeyG6YSHD2nHwXvedd/ZYJf3OFnto7Atw==
   dependencies:
     "@docpocalypse/code-live" "^0.4.18"
     "@docpocalypse/gatsby-theme-core" "^0.8.17"