From 4df3527dbf763232902361bc3f19fea74c73723d Mon Sep 17 00:00:00 2001 From: luckrnx09 Date: Mon, 24 Jun 2024 17:26:43 +0800 Subject: [PATCH] chore: update package info (#4) --- README.md | 16 ++++++++-------- package.json | 6 +++--- src/pkg.ts | 1 + 3 files changed, 12 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 4bafc24..a11b3fe 100644 --- a/README.md +++ b/README.md @@ -20,31 +20,31 @@ Run `cp .env.example .env` then fill the `.env` file: ### Install You can install `abook` as a global command as following: ```bash -yarn global add abook +yarn global add @luckrnx09/abook ``` or ```bash -npm install -g abook +npm install -g @luckrnx09/abook ``` or ```bash -pnpm install -g abook +pnpm install -g @luckrnx09/abook ``` Then you can use `abook -V` to print the abook version installed. If you don't want to install it globally, you can use `npx` to run abook directly: ```bash -npx abook +npx @luckrnx09/abook ``` ### Usage |command|description| |--|--| | ls |list all the ideas| | new |create an idea| - | outline |generate outline from an idea| - | publish |convert book content to markdown| - | rm |remove an idea| - | run |generate book content from an idea with outline| + | outline \ |generate outline from an idea| + | publish \ |convert book content to markdown| + | rm \ |remove an idea| + | run \ |generate book content from an idea with outline| | help [command] |display help for command| ## Develop diff --git a/package.json b/package.json index 69074ba..8813ec9 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { - "name": "abook", - "version": "1.0.0", + "name": "@luckrnx09/abook", + "version": "1.0.1", "description": "

⚡ abook⚡

An AI powered command-line tool for generating any books from scratch

", "bin": { "abook": "dist/index.js" @@ -41,7 +41,7 @@ "homepage": "https://github.com/luckrnx09/abook", "repository": { "type": "git", - "url": "https://github.com/luckrnx09/abook.git" + "url": "git+https://github.com/luckrnx09/abook.git" }, "author": { "name": "luckrnx09", diff --git a/src/pkg.ts b/src/pkg.ts index 12f76db..59f1e1f 100644 --- a/src/pkg.ts +++ b/src/pkg.ts @@ -1,4 +1,5 @@ import * as path from 'path'; const pkg = require(path.resolve(process.cwd(), 'package.json')); +pkg.name = pkg.name.replace('@luckrnx09/', ''); export {pkg};