# template-typescript-npm-cli

[![Test](https://github.com/HiromiShikata/template-typescript-npm-cli/actions/workflows/test.yml/badge.svg)](https://github.com/HiromiShikata/template-typescript-npm-cli/actions/workflows/test.yml)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)

Welcome to template-typescript-npm-cli, this template os for npm command-line.

## How to use this template

1. Grant write permission to gh-actions

   https://github.com/HiromiShikata/template-typescript-npm-cli/settings/actions

1. Set secrets (optional)

   https://github.com/HiromiShikata/template-typescript-npm-cli/settings/secrets/actions
   - [GH_TOKEN](https://github.com/settings/tokens)
   - [NPM_TOKEN](https://www.npmjs.com/settings/hiromi/tokens)
   - [RELEASE_APP_PRIVATE_KEY](https://github.com/settings/apps/semantic-release-changelog)

1. Remove `How to use this template` section from README.md

## Usage 🛠️

Here's how you can use template-typescript-npm-cli:
TODO: copy output of `npx template-typescript-npm-cli --help`

```
Usage: Replace all words [options] <targetDirectoryPath> <beforeWord> <afterWord>

Arguments:
  targetDirectoryPath  Path to the target directory where replacements are to be made
  beforeWord           Word to be replaced throughout the target directory
  afterWord            Word to replace the beforeWord with

Options:

```

## Example 📖

Here's a quick example to illustrate its usage:
TODO:

```
npx template-typescript-npm-cli
```

## Contributing

See [CONTRIBUTING.md](./CONTRIBUTING.md)

## License

MIT