Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
b1tsteller authored Jan 16, 2023
1 parent 9d1d0e8 commit 68b5f1c
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,16 @@ For more information on taggy, more demos and extended docs, please [go here](ht

## Getting Started

**1. Install taggy with npm:**
**Import it via CDN:**

```html
<script src="https://cdn.jsdelivr.net/npm/@b1tsteller/taggy"></script>
```
**Or install taggy with npm:**

`npm install @b1tsteller/taggy`

**2. Import the package and create a new instance with at least an input and an output-element:**
**Then import the package and create a new instance with at least an input and an output-element:**
```node
import { Taggy } from "@b1tsteller/taggy";

Expand All @@ -39,7 +44,7 @@ let taggy = new Taggy(inputElement, outputElement);

- The output-element can be a html-tag of any kind, preferably `<div>`

**3. Get your glossary ready and adjust it to your needs.**
**Get your glossary ready and adjust it to your needs.**

The default comes integrated under `/data/glossary.json` with the data shown below.
But you definetly want to use your own :)
Expand Down

0 comments on commit 68b5f1c

Please sign in to comment.