From 4bb29b5badc157a63166063ee4b2fbc5f81b52e6 Mon Sep 17 00:00:00 2001 From: Jason Dent Date: Sat, 9 Nov 2024 13:00:06 +0100 Subject: [PATCH] chore: work towards release --- .github/workflows/update-dependencies.yml | 4 ---- README.md | 14 ++++++++++++++ package.json | 8 +++++++- static/help.txt | 0 4 files changed, 21 insertions(+), 5 deletions(-) create mode 100644 static/help.txt diff --git a/.github/workflows/update-dependencies.yml b/.github/workflows/update-dependencies.yml index e073abc..8a8015b 100644 --- a/.github/workflows/update-dependencies.yml +++ b/.github/workflows/update-dependencies.yml @@ -51,10 +51,6 @@ jobs: - name: Install run: npm install - - name: Lint Fix - run: | - npm run lint:fix - - name: Git Status id: git-status uses: streetsidesoftware/actions/public/dirty@v1 diff --git a/README.md b/README.md index b7cf55c..d3d9218 100644 --- a/README.md +++ b/README.md @@ -18,3 +18,17 @@ repos: ``` + +## Install from GitHub + +This repo also supports installing the `inject-markdown-cli` directly from GitHub: + +``` +npm install -g git+https://github.com/streetsidesoftware/inject-markdown-cli +``` + +## Usage + +`inject-markdown-cli --help`: + + diff --git a/package.json b/package.json index 339f39e..f50a603 100644 --- a/package.json +++ b/package.json @@ -2,8 +2,14 @@ "name": "inject-markdown-cli", "version": "3.0.0", "description": "Inject Markdown CLI tool that can be used with pre-commit hooks", - "main": "index.js", + "publishConfig": { + "access": "public", + "provenance": true + }, + "type": "module", "scripts": { + "build:readme": "npm run build:help && inject-markdown README.md", + "build:help": "node index.js --help > static/help.txt", "test": "node ./index.js ." }, "repository": { diff --git a/static/help.txt b/static/help.txt new file mode 100644 index 0000000..e69de29