initial release

.storybook/manager.js

@@ -6,8 +6,4 @@ addons.setConfig({
     brandTitle: 'react-obfuscate-ts',
     brandUrl: 'https://github.com/South-Paw/react-obfuscate-ts',
   }),
-  previewTabs: {
-    // 'storybook/docs/panel': { index: -1 },
-    canvas: { hidden: true },
-  },
 });

README.md

@@ -1,6 +1,6 @@
 # @south-paw/react-obfuscate-ts
 
-🕵️ A React component to obfuscate your website's contact links
+🕵️ A React component to obfuscate contact links and text
 
 [![npm](https://img.shields.io/npm/v/@south-paw/react-obfuscate-ts.svg)](https://www.npmjs.com/package/@south-paw/react-obfuscate-ts)
 

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@south-paw/react-obfuscate-ts",
-  "version": "0.0.1-alpha.2",
-  "description": "A React component to obfuscate your website's contact links",
+  "version": "1.0.0",
+  "description": "A React component to obfuscate contact links and text",
   "keywords": [
     "react",
     "component",
@@ -31,25 +31,25 @@
     "url": "https://github.com/South-Paw/react-obfuscate-ts.git"
   },
   "scripts": {
-    "clean": "rimraf dist",
+    "clean": "rimraf dist storybook-static",
     "start": "tsdx watch",
     "start:storybook": "start-storybook -p 9000",
     "build": "tsdx build",
-    "build:storybook": "build-storybook",
+    "build:storybook": "build-storybook --docs",
     "lint": "eslint ./src",
     "test": "tsdx test --passWithNoTests",
     "prepublishOnly": "yarn clean && yarn build"
   },
   "dependencies": {},
   "devDependencies": {
     "@babel/core": "^7.11.4",
-    "@storybook/addon-actions": "^6.0.18",
-    "@storybook/addon-docs": "^6.0.18",
-    "@storybook/addon-knobs": "^6.0.18",
-    "@storybook/react": "^6.0.18",
+    "@storybook/addon-actions": "^6.0.19",
+    "@storybook/addon-docs": "^6.0.19",
+    "@storybook/addon-knobs": "^6.0.19",
+    "@storybook/react": "^6.0.19",
     "@testing-library/jest-dom": "^5.11.4",
     "@testing-library/react": "^10.4.9",
-    "@types/react": "^16.9.47",
+    "@types/react": "^16.9.48",
     "@types/react-dom": "^16.9.8",
     "@types/styled-components": "^5.1.2",
     "@typescript-eslint/eslint-plugin": "^3.10.1",

src/Obfuscate.tsx

@@ -46,6 +46,19 @@ export interface ObfuscateProps extends React.AnchorHTMLAttributes<HTMLAnchorEle
   obfuscateText?: string;
 }
 
+/**
+ * A React component to obfuscate your contact links and text on your website.
+ *
+ * ```
+ * // use the component's children to create the link and display
+ * <Obfuscate email>[email protected]</Obfuscate>
+ *
+ * // or specify the email address for the link with custom children
+ * <Obfuscate email="[email protected]">Email me!</Obfuscate>
+ * ```
+ *
+ * @see https://github.com/South-Paw/react-obfuscate-ts
+ */
 const Obfuscate: React.FC<ObfuscateProps> = ({
   email,
   tel,