Installation

There are three ways to install RepoWidget. Choose the one that fits your workflow.

CDN (recommended for most sites)

The fastest way to get started. Add this script tag before your closing </body> tag:

<!-- jsDelivr CDN (recommended) -->
<script src="https://cdn.jsdelivr.net/npm/repowidget/dist/repoWidget.min.js"></script>

<!-- or unpkg CDN -->
<!-- <script src="https://unpkg.com/repowidget/dist/repoWidget.min.js"></script> -->

The CDN build is always in sync with the latest npm release and requires no local tooling.

npm

Install via npm (or your preferred package manager) if you’re using a bundler:

npm

npm install repowidget

pnpm

pnpm add repowidget

yarn

yarn add repowidget

Then import in your JavaScript or TypeScript file:

import { createRepoWidget } from 'repowidget';

ES module via CDN

If you prefer modules without a local install:

<script type="module">
  import { createRepoWidget } from 'https://cdn.jsdelivr.net/npm/repowidget/dist/repoWidget.esm.js';

  createRepoWidget({
    username: 'your-username',
    containerId: 'repo-container',
  });
</script>

Tip

The CDN script tag approach (non-module) exposes createRepoWidget as a global function, so you can call it from any inline script without an import statement.

Verifying the install

After adding the script, open your browser’s developer console and type:

typeof createRepoWidget

If it returns "function", the widget loaded correctly.