diff --git a/README.md b/README.md index 26749ac..8177aa7 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ -# hugo-node [![CI status](https://github.com/jakejarvis/hugo-node/workflows/Test/badge.svg)](.github/workflows) [![Hugo v0.63.2](https://img.shields.io/badge/Hugo-v0.63.2-orange)](https://github.com/gohugoio/hugo) [![Dependabot](https://api.dependabot.com/badges/status?host=github&repo=jakejarvis/hugo-node)](https://github.com/jakejarvis/hugo-node/pulls?q=is%3Apr+label%3Adependencies) +# hugo-extended via NPM [![CI status](https://github.com/jakejarvis/hugo-node/workflows/Test/badge.svg)](.github/workflows) [![npm](https://img.shields.io/npm/v/hugo-extended)](https://www.npmjs.com/package/hugo-extended) [![Hugo v0.63.2](https://img.shields.io/badge/Hugo-v0.63.2-orange)](https://github.com/gohugoio/hugo) [![Dependabot](https://api.dependabot.com/badges/status?host=github&repo=jakejarvis/hugo-node)](https://github.com/jakejarvis/hugo-node/pulls?q=is%3Apr+label%3Adependencies) -> Plug-and-play binary wrapper for [Hugo](https://gohugo.io/), the awesomest static-site generator. +> Plug-and-play binary wrapper for [Hugo Extended](https://gohugo.io/), the awesomest static-site generator. ## Install ```sh -npm install hugo-node --save-dev +npm install hugo-extended --save-dev # or... -yarn add hugo-node --dev +yarn add hugo-extended --dev ``` -`hugo-node` defaults to the [extended version](https://gohugo.io/getting-started/installing/#linux) of Hugo on [supported platforms](https://github.com/gohugoio/hugo/releases), and falls back to vanilla Hugo automatically if unsupported. +`hugo-extended` defaults to the [extended version](https://gohugo.io/getting-started/installing/#linux) of Hugo on [supported platforms](https://github.com/gohugoio/hugo/releases), and falls back to vanilla Hugo automatically if unsupported. ## Usage @@ -18,7 +18,7 @@ yarn add hugo-node --dev ```js const { execFile } = require('child_process'); -const hugo = require('hugo-node'); +const hugo = require('hugo-extended'); execFile(hugo, ['version'], (error, stdout) => { if (error) { diff --git a/package-lock.json b/package-lock.json index 97f3a92..c46275c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,5 +1,5 @@ { - "name": "@jakejarvis/hugo", + "name": "hugo-extended", "version": "0.63.2", "lockfileVersion": 1, "requires": true, diff --git a/package.json b/package.json index 6c5c622..3bd2a3a 100644 --- a/package.json +++ b/package.json @@ -1,12 +1,22 @@ { - "name": "hugo-node", + "name": "hugo-extended", "version": "0.63.2", "hugoVersion": "0.63.2", - "description": "Binary wrapper for Hugo", - "repository": "jakejarvis/hugo-node", + "description": "Plug-and-play binary wrapper for Hugo Extended, the awesomest static-site generator.", + "homepage": "https://github.com/jakejarvis/hugo-node#readme", "license": "MIT", + "author": { + "name": "Jake Jarvis", + "email": "jake@jarv.is", + "url": "https://github.com/jakejarvis" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/jakejarvis/hugo-node.git" + }, "keywords": [ "hugo", + "hugo extended", "gohugoio", "cli", "bin", @@ -15,9 +25,6 @@ "static site generator" ], "main": "index.js", - "bin": { - "hugo": "cli.js" - }, "dependencies": { "bin-wrapper": "^4.1.0", "rimraf": "^3.0.1", @@ -34,13 +41,16 @@ "test": "npm run eslint && npm run mocha", "postinstall": "rimraf vendor && node lib/install" }, + "engines": { + "node": ">=10" + }, "files": [ "lib/*.js", "cli.js", "index.js" ], - "engines": { - "node": ">=10" + "bin": { + "hugo": "cli.js" }, "eslintConfig": { "extends": "eslint:recommended",