Merge pull request #1146 from nunocoracao/dev

🔖 v2.50.0

CONTRIBUTING.md

@@ -35,9 +35,9 @@
 - Indent using 2 spaces (soft tabs).
 - Put spaces between list items (ie. `[1, 2, 3]`, not `[1,2,3]`), around operators (ie. `1 + 1`, not `1+1`) and inside go templating tags (ie. `{{< alert >}}`, not `{{<alert>}}`).
 - Avoid code reuse in templates by extracting components into partials.
-- Layout code in a logical manner that prioritises readibility.
+- Layout code in a logical manner that prioritises readability.
 - Add comments when the intent of the code isn't immediately apparent or to break up large blocks of logic.
-- Use relative paths to assets without including the preceeding slash but, when referring to a folder, including a trailing slash (ie. `static/img/`, not `/static/img/` or `/static/img`).
+- Use relative paths to assets without including the preceding slash but, when referring to a folder, including a trailing slash (ie. `static/img/`, not `/static/img/` or `/static/img`).
 - Any static text must be referenced using the `i18n` methods and included in the localisation assets.
 - Commit often, preferring incremental changes rather than bundling everything into a single, large commit.
 

README.md

@@ -37,7 +37,7 @@ Blowfish is designed to be a powerful, lightweight theme for [Hugo](https://gohu
 - Flexible with any content types, taxonomies and menus
 - Header and footer menus
 - Nested menus & sub-navigation menu
-- Multilingual content support inlcuding support for RTL languages
+- Multilingual content support including support for RTL languages
 - Ability to link to posts on third-party websites
 - Support for several shortcodes like Gallery, Timeline, GitHub cards, and Carousels
 - Buymeacoffee integration
@@ -71,6 +71,27 @@ Blowfish supports several installation methods - as a git submodule, a Hugo Modu
 
 Detailed instructions for each method can be found in the [Installation](https://blowfish.page/docs/installation) docs. You should consult the documentation for the simplest setup experience. Below is a quick start guide using submodules if you are using git, or Hugo modules if you're already confident installing Hugo themes.
 
+### Quick start using Blowfish Tools
+
+> **Note:** Ensure you have **Node.js**, **Git**, **Go** and **Hugo** installed, and that you have created a new Hugo project before proceeding.
+
+We just launched a new CLI tool to help you get started with Blowfish. It will create a new Hugo project, install the theme and set up the theme configuration files for you. It's still in beta so please [report any issues you find](https://github.com/nunocoracao/blowfish-tools).
+
+Install the CLI tool globally using npm (or other package manager):
+```shell
+npm i -g blowfish-tools
+```
+
+Then run the command `blowfish-tools` to start an interactive run which will guide you through creation and configuration use-cases.
+```shell
+blowfish-tools
+```
+
+You can also run the command `blowfish-tools new` to create a new Hugo project and install the theme in one go. Check the CLI help for more information.
+```shell
+blowfish-tools new mynewsite
+```
+
 ### Quick start using git submodules
 
 > **Note:** Ensure you have **Git**, **Go**, and **Hugo** installed, and that you have created a new Hugo project before proceeding.