https://github.com/victornpb/template-library-with-rollup

Template repository for creating libraries, with Rollup + Babel.
https://github.com/victornpb/template-library-with-rollup

Last synced: 6 months ago
JSON representation

Template repository for creating libraries, with Rollup + Babel.

• Host: GitHub
• URL: https://github.com/victornpb/template-library-with-rollup
• Owner: victornpb
• License: mit
• Created: 2021-02-22T02:23:13.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-06-05T09:04:42.000Z (over 2 years ago)
• Last Synced: 2025-02-09T03:21:55.654Z (8 months ago)
• Language: JavaScript
• Homepage:
• Size: 1.04 MB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# foo-bar

[![LICENSE](https://img.shields.io/github/license/username/foo-bar?style=flat-square)](LICENSE)

[![Node](https://img.shields.io/node/v/foo-bar.svg?style=flat-square)](package.json)

[![CodeFactor](https://www.codefactor.io/repository/github/username/foo-bar/badge?style=flat-square)](https://www.codefactor.io/repository/github/username/foo-bar)

[![Coverage Status](https://img.shields.io/coveralls/username/foo-bar.svg?style=flat-square)](https://coveralls.io/github/username/foo-bar)

![Snyk Vulnerabilities for GitHub Repo](https://img.shields.io/snyk/vulnerabilities/github/username/foo-bar?style=flat-square)

[![Version](https://img.shields.io/npm/v/foo-bar.svg?style=flat-square)](https://www.npmjs.com/package/foo-bar)

[![Downloads](https://img.shields.io/npm/dt/foo-bar.svg?style=flat-square)](https://www.npmjs.com/package/foo-bar)

[![](https://img.shields.io/bundlephobia/minzip/foo-bar?style=flat-square)](https://www.npmjs.com/package/foo-bar)

[![](https://img.shields.io/tokei/lines/github/username/foo-bar?style=flat-square)](https://www.npmjs.com/package/foo-bar)

[![GitHub Stars](https://img.shields.io/github/stars/username/foo-bar?style=flat-square)](https://github.com/username/foo-bar/stargazers)

[![GitHub Forks](https://img.shields.io/github/forks/username/foo-bar?style=flat-square)](https://github.com/username/foo-bar/network/members)

[![GitHub Discussions](https://img.shields.io/github/discussions/username/foo-bar?style=flat-square)](https://github.com/username/foo-bar/discussions)

[![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed/username/foo-bar?style=flat-square&color=green)](https://github.com/username/foo-bar/pulls?q=is%3Apr+is%3Aclosed)

[![GitHub closed issues](https://img.shields.io/github/issues-closed/username/foo-bar?style=flat-square&color=green)](https://github.com/username/foo-bar/issues?q=is%3Aissue+is%3Aclosed)

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla non erat non enim ultricies cursus. Nullam quis tortor vel ex aliquet luctus. Aliquam erat volutpat. Donec quis libero lacus. Fusce quis leo vitae purus convallis luctus sed a ex. Phasellus vel mauris in ante bibendum efficitur. Nunc eget dictum purus. Proin vel lectus euismod, blandit nunc in, aliquam quam.

# Usage Examples

Inside your code you can do something like this:

## Basic usage

```js

import FooBar from 'foo-bar';

// us

FooBar();

```

# Installation

## [NPM](https://npmjs.com/package/foo-bar)

```sh

npm install foo-bar

```

## [Yarn](https://github.com/yarnpkg/yarn)

```sh

yarn add --dev foo-bar

```

# Adding to your project

#### index.js

```js

import fooBar from 'foo-bar';

// setup

import foobar from 'foo-bar';

fobar.init({options});

```

## Options

foobar(variables, options)

| Parameters  | Description           | Type    | Default Value |

|-------------|-----------------------|---------|---------------|

| `foo`       | This is the foo thing | object  | `{}`          |

| `enable`    | Enable the thing      | boolean | `true`        |

| `options.x` | The X value           | number  | `1.0`         |

| `options.y` | The X value           | number  | `2.0`         |

| `options.z` | The X value           | number  | `3.0`         |

### Options example

```js

import foobar from 'foo-bar';

fobar.init({

  enable: true,

});

```

## License

The code is available under the [MIT](LICENSE) license.

## Contributing

We are open to contributions, see [CONTRIBUTING.md](CONTRIBUTING.md) for more info.

You need at least Node 18 to build the project