API section to readme.

namitoyokota · May 18, 2024 · 8c94305 · 8c94305
1 parent 5e85555
commit 8c94305
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -66,19 +66,15 @@ Lastly, add component in the HTML.
 <notation-reveal [config]="underline">This sentence will be underlined.</notation-reveal>
 ```
 
-## Directives
+## API
 
-Optionally, override the reset flag to avoid re-animations.
+This readonly component takes in the following properties as inputs:
 
-```html
-<notation-reveal [reset]="false"></notation-reveal>
-```
-
-Delay, set to 1000 milliseconds (1 second) by default, can also be overridden.
-
-```html
-<notation-reveal [delay]="5000"></notation-reveal>
-```
+| Name     | Type                                                                                                                 | Default | Description                                                         |
+| -------- | -------------------------------------------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------- |
+| `config` | [RoughAnnotationConfig](https://github.com/rough-stuff/rough-notation?tab=readme-ov-file#configuring-the-annotation) |         | Styling of the annotation.                                          |
+| `reset`  | boolean                                                                                                              | true    | Whether to re-animate annotation each time element enters viewport. |
+| `delay`  | number                                                                                                               | 1000    | Time before animation after element enters viewport (in ms).        |
 
 ## License
 

diff --git a/projects/ngx-notation-reveal/package.json b/projects/ngx-notation-reveal/package.json
@@ -1,6 +1,6 @@
 {
     "name": "ngx-notation-reveal",
-    "version": "17.0.0",
+    "version": "17.0.1",
     "description": "Angular component to add rough notation when element is visible.",
     "author": {
         "name": "Namito Yokota",