readme.md

BEFORE YOU PUBLISH

• Read Libraries van Kaliber.
• Make sure your example works.
• Make sure your package.json is correct. Have you change the library title?
• Update the bin/postInstall script. It should refer to your library.
• Update the <title> tag in index.html.js.
• Remove 'BEFORE YOU PUBLISH' and 'PUBLISHING' from this document.

PUBLISHING

• Make sure you are added to the kaliber organization on NPM
• run yarn publish
• Enter a correct version, we adhere to semantic versioning (semver)
• run git push
• run git push --tags
• Send everybody an email to introduce them to your library!

Library title

Short description.

Motivation

Optionally add a bit of text describing why this library exists.

Installation

yarn add @kaliber/library

Usage

Short example. If your library has multiple ways to use it, show the most used one and refer to /example for further examples.

import { hello } from 'library'

function Component() {
  return <div>{hello()}</div>
}

Reference

Optionally add a reference, if your library needs it.

Disclaimer

This library is intended for internal use, we provide no support, use at your own risk. It does not import React, but expects it to be provided, which @kaliber/build can handle for you.

This library is not transpiled.