@interaktiv/mibuilder-core/README.md

Core libraries to interact with MiBuilder projects.

# @interaktiv/mibuilder-core

> Core libraries to interact with [MiBuilder][] projects.

[![Commitizen friendly][commitizen-badge]][commitizen]
[![Conventional Commits][conventional-commits-badge]][conventional-commits]
[![Semantic Release][semantic-release-badge]][semantic-release]
[![Code of Conduct][coc-badge]][coc] [![MIT License][license-badge]][license]

[![npm latest version][latest-version-badge]][package]
[![npm next version][next-version-badge]][package]

## This Solution

Core libraries to interact with [MiBuilder][] projects and other utilities.

## Table of Contents

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

- [Installation](#markdown-header-installation)
- [Usage](#markdown-header-usage)
- [References](#markdown-header-references)
- [Other Use Cases](#markdown-header-other-use-cases)
- [Acknowledgements](#markdown-header-acknowledgements)
- [License](#markdown-header-license)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## Installation

This module can be installed via [npm][npm-cli] which is bundled with
[Node.js][node] and should be installed as one of your project's
[dependencies][]:

```bash
npm install --save @interaktiv/mibuilder-core
```

## Usage

See the draft [API Documentation](./docs/EXPORTED.md).

## References

- [@interaktiv/dxl][interaktiv-dxl] - A development Library for Javascript
  projects
- [@interaktiv/errors][interaktiv-errors] - Contains custom error types
- [@interaktiv/json][interaktiv-json] - Contains JSON related utilities
- [@interaktiv/traveling-fastlane][interaktiv-traveling-fastlane] - Contains
  specific scripts to interact with fastlane
- [@interaktiv/types][interaktiv-types] - Contains custom types
- [@interaktiv/mibuilder-colors][mibuilder-colors] - Standard colors for
  [MiBuilder][] CLI
- [@interaktiv/mibuilder-command][mibuilder-command] - Contains base
  [MiBuilder][] CLI command, `MiBuilderCommand`.

## Other Use Cases

If you lack some use cases, you are welcome to open a pull request and add it.
We'll come back to you and see how we can support your use case and present it
to all devs.

Please consult the [contribution guides][contributing] before contributing.

## Acknowledgements

This library is heavily inspired by [@salesforce/core][salesforce-core]. Thank
you 💙

## License

[MIT][license] Copyright © 2020-present [die.interaktiven GmbH & Co.
KG][dia-website]

[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg
[coc]: ./other/CODE_OF_CONDUCT.md
[commitizen]: http://commitizen.github.io/cz-cli
[commitizen-badge]:
  https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
[contributing]: ./CONTRIBUTING.md
[conventional-commits]: https://conventionalcommits.org
[conventional-commits-badge]:
  https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg
[dependencies]:
  https://docs.npmjs.com/specifying-dependencies-and-devdependencies-in-a-package-json-file
[dia-website]: https://die-interaktiven.de
[downloads-badge]: https://img.shields.io/npm/dw/@interaktiv/mibuilder-core.svg
[downloads-total-badge]:
  https://img.shields.io/npm/dt/@interaktiv/mibuilder-core.svg
[interaktiv-dxl]: https://www.npmjs.com/package/@interaktiv/dxl
[interaktiv-errors]: https://www.npmjs.com/package/@interaktiv/errors
[interaktiv-json]: https://www.npmjs.com/package/@interaktiv/json
[interaktiv-traveling-fastlane]:
  https://www.npmjs.com/package/@interaktiv/traveling-fastlane
[interaktiv-types]: https://www.npmjs.com/package/@interaktiv/types
[latest-version-badge]:
  https://img.shields.io/npm/v/@interaktiv/mibuilder-core/latest.svg
[license]: https://opensource.org/licenses/MIT
[license-badge]: https://img.shields.io/npm/l/@interaktiv/mibuilder-core.svg
[mibuilder]: https://npmjs.com/package/@interaktiv/mibuilder
[mibuilder-colors]: https://npmjs.com/package/@interaktiv/mibuilder-colors
[mibuilder-command]: https://npmjs.com/package/@interaktiv/mibuilder-command
[next-version-badge]:
  https://img.shields.io/npm/v/@interaktiv/mibuilder-core/next.svg
[package]: https://npmjs.com/package/@interaktiv/mibuilder-core
[node]: https://nodejs.org
[npm]: https://www.npmjs.com
[npm-cli]: https://www.npmjs.com/package/npm
[salesforce-core]: https://www.npmjs.com/package/@salesforce/core
[salesforce-ts-types]: https://www.npmjs.com/package/@salesforce/ts-types
[semantic-release]: https://github.com/semantic-release/semantic-release
[semantic-release-badge]:
  https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
[version-badge]: https://img.shields.io/npm/v/@interaktiv/mibuilder-core.svg