chore: update documentation

programmerg · programmerg · commit 867733ded3a3 · 2026-02-02T10:19:15.000+01:00
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2026 Gelencsér Gergő
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,13 +1,13 @@
 <p align="center">
-  <img src="logo.svg" alt="bs-elements" width="128" height="128">
+  <img src="https://programmerg.github.io/bs-elements/logo.svg" alt="bs-elements" width="128" height="128">
 </p>
 
 # bs-elements
 
-A **Bootstrap 5–based, framework-agnostic Web Component library** built around the Bootstrap philosophy: 
+A **Bootstrap 5–based, framework-agnostic Web Component library** built around the Bootstrap philosophy:<br>
 _class-first markup, minimal abstraction, and a thin DOM wrapper_.
 
-bs-elements augments existing Bootstrap HTML and JavaScript with a **declarative Custom Element API** 
+bs-elements augments existing Bootstrap HTML and JavaScript with a **declarative Custom Element API**<br>
 — without hiding, replacing, or reinventing Bootstrap.
 
 ## 🎯 Goals
@@ -28,14 +28,21 @@ Explicitly not a goal:
 Good old way
 
 1. Follow the [official guide](https://getbootstrap.com/docs/5.3/getting-started/introduction/)
-2. replace `bootstrap.boundle.min.js` with `bs-elements.boundle.min.js`
-3. or add the `<script src="bs-elements.min.js"></script>` next to it
+2. replace `bootstrap.boundle.min.js` with our `bs-elements.boundle.min.js`<br>
+  or keep it and add `bs-elements.min.js` next to it.
+
+CDN links
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/@programmerg/bs-elements@0.1.0/dist/bs-elements.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@programmerg/bs-elements@0.1.0/dist/bs-elements.boundle.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@programmerg/bs-elements@0.1.0/dist/bs-elements.esm.js" type="module"></script>
+```
 
 ES Modules
 
-- Use the `<script src="bs-elements.esm.js" type="module"></script>`
-- or install it with the command: `npm i programmerg/bs-elements`
-- then you can import it as `import * from 'bs-elements'`
+- Run the `npm i @programmerg/bs-elements` command
+- and use `import * from '@programmerg/bs-elements'` 
 
 ## 🧠 Design Principles
 
@@ -146,3 +153,7 @@ If required Bootstrap structure is missing, BsElements fills the gap.
 - `connectedCallback` → initialize Bootstrap instance
 - Attribute changes → synchronize options
 - `disconnectedCallback` → clean up
+
+---
+
+<p align="center">Made with ❤️, HTML and JS.</p>
diff --git a/dist/.gitignore b/dist/.gitignore
@@ -1,2 +1,3 @@
 *
-!.gitignore
+!.gitignore
+!.npmignore
diff --git a/dist/.npmignore b/dist/.npmignore
@@ -0,0 +1 @@
+.gitignore
diff --git a/index.html b/index.html
diff --git a/package.json b/package.json

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`*`
`2`		`-!.gitignore`
	`2`	`+!.gitignore`
	`3`	`+!.npmignore`