@marketto/belfiore-connector-embedded/README.md

TS & JS Belfiore datasource connector: embedded dataset

# belfiore-connector-embedded

**Belfiore datasource connector: embedded dataset**
Best for embedded FE usage

[![NPM Version](https://img.shields.io/npm/v/@marketto/belfiore-connector-embedded.svg)](https://www.npmjs.com/package/@marketto/belfiore-connector-embedded)
[![NPM Downloads](https://img.shields.io/npm/dm/@marketto/belfiore-connector-embedded.svg)](https://www.npmjs.com/package/@marketto/belfiore-connector-embedded)
[![LICENSE](https://img.shields.io/badge/licese-MIT-gold.svg)](https://github.com/Marketto/belfiore-connector-embedded/blob/master/LICENSE)
[![Blog](https://img.shields.io/badge/blog-marketto-blue.svg)](http://blog.marketto.it)
[![Buy me a coffee](https://img.shields.io/badge/Ko--fi-donate-blueviolet)](https://ko-fi.com/marketto)

## 🖋️ WRITE YOUR OWN CONNECTOR

Not the **BelfioreConnector** you are looking for?

[**@marketto/belfiore-connector**](https://www.npmjs.com/package/@marketto/belfiore-connector): Abstract class & interfaces to write your own connector

## 🔌 INSTALLATION

### NPM

```{r, engine='bash', global_install}
npm i -s @marketto/belfiore-connector-embedded
```

### Script

```html
<script src="https://unpkg.com/@marketto/belfiore-connector-embedded/dist/belfiore-connector-embedded.bundle.min.js"></script>
```

## 🔧 USAGE

This lib provide an initialized instance of BelfioreConnector including all the places data

### CJS

```javascript
const belfioreConnector = require("@marketto/belfiore-connector-embedded");
```

### MJS & TypeScript

```javascript
import belfioreConnector from "@marketto/belfiore-connector-embedded";
```

## 📖 DOCUMENTATION

[JsDocs @ GitHub Pages](https://marketto.github.io/belfiore-connector-embedded/)

## 📙 [CHANGELOG](CHANGELOG.MD)

## 🔃 Compatibility

- [x] NodeJs
- [x] Chrome
- [x] Firefox
- [x] Edge

## ✋ DISCLAMER

All names, informations, and fiscal codes used in this README and all unit tests are fictitious.
No identification with actual persons (living or deceased) is intended or should be inferred

## 📜 [LICENSE: MIT](LICENSE)

## 📚 ASSETS LICENSES AND AUTHORS

- Cities List of Values: [CC BY 4.0](asset/MINISTERO_DELL_INTERNO.LICENSE) Ministero dell'interno
- Cities List of Values: [CC BY 4.0](asset/AGENZIA_DELLE_ENTRATE.LICENSE) Agenzia delle Entrate
- Countries List of Values: [CC BY 3.0](asset/ISTITUTO_NAZIONALE_DI_STATISTICA.LICENSE) Istituto nazionale di statistica

## 📝 AUTHOR

[Marco Ricupero](mailto:marco.ricupero@gmail.com)