Update readme document with instructions.

namitoyokota · May 18, 2024 · 7b72f0d · 7b72f0d
1 parent ca449d4
commit 7b72f0d
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -30,6 +30,17 @@ or
 yarn add ngx-code-snippet
 ```
 
+### API
+
+This readonly component takes in the following properties as inputs:
+
+| Name              | Type    | Default | Description                                                                                              |
+| ----------------- | ------- | ------- | -------------------------------------------------------------------------------------------------------- |
+| `code`            | string  | ""      | Code to display.                                                                                         |
+| `language`        | string  | ""      | Language of the code snippet. Automatic language detection is supported when this field is not provided. |
+| `showCopy`        | boolean | true    | Show/hide copy button.                                                                                   |
+| `showLineNumbers` | boolean | false   | Show/hide line numbers.                                                                                  |
+
 ## License
 
 [MIT](https://github.com/namitoyokota/ngx-code-snippet/blob/master/LICENSE) &copy; [Namito Yokota](https://www.namitoyokota.com)
diff --git a/projects/ngx-code-snippet/package.json b/projects/ngx-code-snippet/package.json
@@ -1,6 +1,6 @@
 {
     "name": "ngx-code-snippet",
-    "version": "17.0.3",
+    "version": "17.0.4",
     "description": "Angular component to display code snippets with syntax highlighting.",
     "author": {
         "name": "Namito Yokota",

diff --git a/src/app/app.component.html b/src/app/app.component.html
@@ -112,8 +112,6 @@ <h2>API</h2>
     </div>
 </section>
 
-<hr />
-
 <!-- License -->
 <p>
     <a href="https://github.com/namitoyokota/ngx-code-snippet/blob/master/LICENSE" target="_blank">MIT</a> &copy;
-Original file line number
+Diff line change
@@ Expand Up / @@ -112,8 +112,6 @@ <h2>API</h2> @@
         </div>
     </section>
-    <hr />
     <!-- License -->
     <p>
         <a href="https://github.com/namitoyokota/ngx-code-snippet/blob/master/LICENSE" target="_blank">MIT</a> &copy;
@@ Expand Down @@