diff --git a/README.md b/README.md index 0b4a53f..34db5b9 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # Codex Factory [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io) -[![Version](https://img.shields.io/npm/v/@codex-storage/codex-factory.svg)](https://npmjs.org/package/@codex-storage/codex-factory) -[![Downloads/week](https://img.shields.io/npm/dw/@codex-storage/codex-factory.svg)](https://npmjs.org/package/@codex-storage/codex-factory) +[![Version](https://img.shields.io/npm/v/codex-factory.svg)](https://npmjs.org/package/codex-factory) +[![Downloads/week](https://img.shields.io/npm/dw/codex-factory.svg)](https://npmjs.org/package/codex-factory) [![Tests](https://github.com/codex-storage/codex-factory/actions/workflows/test.yaml/badge.svg)](https://github.com/codex-storage/codex-factory/actions/workflows/test.yaml) ![](https://img.shields.io/badge/npm-%3E%3D10.0.0-orange.svg?style=flat-square) ![](https://img.shields.io/badge/Node.js-%3E%3D20.0.0-orange.svg?style=flat-square) @@ -21,7 +21,13 @@ **Requirements:** Docker ```shell -$ npm install -g @codex-storage/codex-factory +$ npm install -g codex-factory +``` + +You can also use this CLI directly thanks to `npx` without installing it: + +```shell +$ npx codex-factory start 0.2.0 ``` ## Usage diff --git a/package.json b/package.json index a6c5483..ecdcd8b 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "@codex-storage/codex-factory", + "name": "codex-factory", "description": "Orchestration CLI for spinning up local development Codex cluster with Docker", "version": "0.1.0", "author": "Codex Authors", @@ -40,7 +40,7 @@ "typescript": "^5" }, "engines": { - "node": ">=18.0.0", + "node": ">=20.0.0", "npm": ">=6.0.0", "codex": "0.2.1", "supportedCodex": ">0.2.0" @@ -80,9 +80,9 @@ "build": "shx rm -rf dist && tsc -b", "lint": "eslint", "postpack": "shx rm -f oclif.manifest.json", + "prepare": "npm run build", "prepack": "oclif manifest && oclif readme", - "test": "mocha --forbid-only \"test/**/*.test.ts\"", - "version": "oclif readme && git add README.md" + "test": "mocha --forbid-only \"test/**/*.test.ts\"" }, "types": "dist/index.d.ts" }