@anjanak13/bootstrap-v5-theme/README.md

Goverment of British Columbia Bootstrap v5 theme

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
[![Lifecycle:Experimental](https://img.shields.io/badge/Lifecycle-Experimental-339999)](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)

# 🚀 Government of British Columbia Bootstrap v5 npm Package

This package contains assets such as images, fonts as well as minified CSS and JS files to incorporate into your own project. 

## Use of the Package

### Direct Usage

- To refer to the assets directly within your project, you can link them to your project as such:

    - CSS: `node_modules/@<your-namespace>/bootstrap-v5-theme/css/bootstrap-theme.min.css`
    - JS: `node_modules/@<your-namespace>/bootstrap-v5-theme/css/bootstrap-theme.min.js`
    
### Usage by importing assets

- To import the assets and use them in your project, you can import them through your index.js through

```bash
const bootstrapTheme = require('@<your-namespace>/bootstrap-v5-theme');`
```