From 0ca0a98d08521fc2f4baeb1574ad92473d10e8f6 Mon Sep 17 00:00:00 2001
From: Tsukina-7mochi <Tsukina7mochi@gmail.com>
Date: Sun, 9 Jun 2024 18:43:26 +0900
Subject: [PATCH] docs: add description to use with npm

---
 readme.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/readme.md b/readme.md
index fc17f7e..9035419 100644
--- a/readme.md
+++ b/readme.md
@@ -25,6 +25,8 @@ Check out this live demo to see GitHub Repo Cards in action:
 https://tsukina-7mochi.github.io/github-cards/
 
 ## Usage
+
+### via CDN
  
 You can import script from CDN `esm.sh`. Add the following `<script>` tag to your HTML document to load library:
 
@@ -40,6 +42,16 @@ Use the `<gh-repo-card>` custom element wherever you want to display a GitHub re
 
 See `docs` directory for demonstration page implementation.
 
+### via npm
+
+You can simply import this library instead of loading from CDN:
+
+```typescript
+require('@tsukina-7mochi/github-cards`);
+// or
+import '@tsukina-7mochi/github-cards`;
+```
+
 ## API
 
 ### gh-repo-card