html-to-ascii 0.3.1 → 0.3.2

package/README.md

@@ -78,7 +78,7 @@ html-to-ascii supports three interchangeable methods for customizing the look of
 #### 1. Adding props to `<ASCIIProvider>`:
 
 This method changes the global style for every element unless locally overridden.
-_(A full list of options can be seen [here](#api))_
+_(A full list of options can be seen [here](#asciiprovider))_
 
 ```html
 <!--set the left and right borders to ":"-->
@@ -99,7 +99,7 @@ Output
 
 #### 2. Using class names on elements inside of `<ASCII>` to enable certain ASCII features:
 
-_(A full list of class names can be seen [here](#api))_
+_(A full list of class names can be seen [here](#ascii))_
 
 ```jsx
 <ASCII>
@@ -128,7 +128,7 @@ Output
 
 #### 3. Using class names on elements inside of `<ASCII>` to override global styles:
 
-This method allows you to add local styling to a single element without changing the styles of other elements. _(A full list of override class names can be seen [here](#api))_
+This method allows you to add local styling to a single element without changing the styles of other elements. _(A full list of override class names can be seen [here](#ascii))_
 
 ```jsx
 <ASCII>
@@ -181,9 +181,11 @@ ASCII art can contain some weird character combinations, and sometimes that mess
 </ASCII>
 ```
 
-### API
+## API
 
-#### `<ASCIIProvider>` Props:
+## `<ASCIIProvider>`
+
+### Props:
 
 | Prop   | Type      | Default | Description           |
 | ------ | --------- | ------- | --------------------- |
@@ -202,7 +204,16 @@ ASCII art can contain some weird character combinations, and sometimes that mess
 | `i`    | `string?` | `'┼'`   | Four-way intersection |
 | `fill` | `string?` | `' '`   | Element fill          |
 
-#### `<ASCII>` Class names:
+## `<ASCII>`
+
+### Props:
+
+| Prop          | Type       | Default | Description                          |
+| ------------- | ---------- | ------- | ------------------------------------ |
+| `gridReveal`  | `boolean?` | `true`  | Toggle scan-style reveal of the grid |
+| `revealSpeed` | `number?`  | `30`    | Speed of the grid reveal             |
+
+### Class names:
 
 | Class name        | Description                                 |
 | ----------------- | ------------------------------------------- |
@@ -219,7 +230,7 @@ ASCII art can contain some weird character combinations, and sometimes that mess
 | `ascii-text`      | Enable text                                 |
 | `ascii-no-fill`   | Disable element's fill (will be "see-thru") |
 
-#### `<ASCII>` Override class names:
+### Override class names:
 
 Replace '#' with your desired character
 

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "html-to-ascii",
 	"private": false,
-	"version": "0.3.1",
+	"version": "0.3.2",
 	"type": "module",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
@@ -15,6 +15,23 @@
 	"files": [
 		"dist"
 	],
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/zachariahwatson/html-to-ascii"
+	},
+	"keywords": [
+		"react",
+		"ascii",
+		"html-to-ascii",
+		"ascii-wrapper",
+		"ascii-dom",
+		"ascii-overlay",
+		"ascii-react",
+		"ascii-component",
+		"react-component"
+	],
+	"author": "Zachariah Watson",
+	"license": "MIT",
 	"scripts": {
 		"dev": "vite",
 		"build": "tsc -b ./tsconfig.lib.json && vite build",