Introduction

<INTRO TEXT>

Table of Contents

1. Quick Start
2. Documentation
3. DevOps
   1. Change Management
   2. Publish

Quick Start

# placeholder:
    # <NEW_PACKAGE: <NEW_PACKAGE>
    # <TEMPLATE_PACKAGE_NAME: @temir.ra/create-template
    # <TEMPLATE_NAME: @temir.ra/template

mkdir -p <NEW_PACKAGE>
cd <NEW_PACKAGE>

# print the latest version
bun info "@temir.ra/create-template" version

# create/update a package from the template in the current directory
bun create --no-install --no-git "@temir.ra/template@latest" .

# set metadata in package.json

bun install

Documentation

The following sections explain the configurations and conventions baked into the generated package. Useful when adapting it to fit specific needs.

<DOCUMENTATION>

DevOps

bun update
bun install

bun run clean
bun run build
bun run tests

bun run dist/cli.bundle.js -- example/

# see publish section for publish instructions

Change Management

1. Create a new branch for the change.
2. Make the changes and commit.
3. Bump the version in package.json.
4. Add an entry for the new version in CHANGELOG.md.
5. Pull request the branch.
6. Ensure package artifacts are current.
7. Publish.

Publish

Publish to the public npm registry.

# authenticate
npm login
# publish
bun publish --registry https://registry.npmjs.org/ --access public