Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nunocoracao authored Jan 14, 2024
1 parent f06006f commit 90de54d
Showing 1 changed file with 31 additions and 2 deletions.
33 changes: 31 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [Blowfish Tools](https://blowfish.page/) ·

# [Blowfish Tools](https://blowfish.page/)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/nunocoracao/blowfish-tools/blob/main/LICENSE)
[![Node.js Package](https://github.com/nunocoracao/blowfish-tools/actions/workflows/release-package.yml/badge.svg)](https://github.com/nunocoracao/blowfish-tools/actions/workflows/release-package.yml)
[![npm version](https://img.shields.io/npm/v/blowfish-tools.svg?style=flat-square)](https://www.npmjs.org/package/blowfish-tools)
Expand All @@ -9,7 +8,37 @@
CLI to initialize and configure a [Blowfish](https://blowfish.page) project. Install the CLI globally and run `blowfish-init` to start the interactive prompt that will walk you through setting up a Blowfish from scratch or configure an existing project.

## Installation
Install globally using:

```bash
npm install -g blowfish-tools
```

## Interactive run

Start an interactive run with

```bash
blowfish-tools
```

## Non-interactive run

Use this package as part of scripts or CI/CD actions

```bash
blowfish-tools -h
Usage: blowfish-tools [options] [command]

CLI to initialize and configure a Blowfish project.
Use `blowfish-tools` to start the interactive prompt.
Run `blowfish-tools --help` for more information.

Options:
-V, --version output the version number
-h, --help display help for command

Commands:
new <folder> Creates a new Blowfish project from scratch on the selected folder
install Installs Blowfish on an existing Hugo project (assumes current directory).
```

0 comments on commit 90de54d

Please sign in to comment.