Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update package info #4

Merged
merged 1 commit into from
Jun 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <idea> |generate outline from an idea|
| publish <idea> |convert book content to markdown|
| rm <idea> |remove an idea|
| run <idea> |generate book content from an idea with outline|
| outline \<idea\> |generate outline from an idea|
| publish \<idea\> |convert book content to markdown|
| rm \<idea\> |remove an idea|
| run \<idea\> |generate book content from an idea with outline|
| help [command] |display help for command|

## Develop
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "abook",
"version": "1.0.0",
"name": "@luckrnx09/abook",
"version": "1.0.1",
"description": "<h1 align=\"center\">⚡ abook⚡</h1> <p align=\"center\"> An AI powered command-line tool for generating any books from scratch</p>",
"bin": {
"abook": "dist/index.js"
Expand Down Expand Up @@ -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",
Expand Down
1 change: 1 addition & 0 deletions src/pkg.ts
Original file line number Diff line number Diff line change
@@ -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};