Skip to content

Commit

Permalink
chore: fix inconsistent README (#252)
Browse files Browse the repository at this point in the history
  • Loading branch information
xhayper authored May 11, 2024
1 parent 32a01d6 commit b204d66
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .changeset/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ We have a quick list of common questions to get you started engaging with this p
The release steps follows this:

- "bun run prerelease"
- "bun install -r"
- "bun install"
- "bun run publish"
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,17 @@ This repo serves as a monorepo that houses several packages, mainly the `guilded

### Using `create-guilded-app`

- `npm init guilded-app <project-name>`
- `yarn create guilded-app <project-name>`
- `pnpm create guilded-app <project-name>`
- `npm init guilded-app <project-name>`
- `bun create guilded-app <project-name>`

### Manual Installation

- `npm install guilded.js`
- `yarn add guilded.js`
- `pnpm add guilded.js`
- `bun add guilded.js`

## ⚡ Usage

Expand Down
2 changes: 2 additions & 0 deletions packages/api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ You can install this package from [NPM](https://www.npmjs.com/package/@guildedjs

- `npm install @guildedjs/api`
- `yarn add @guildedjs/api`
- `pnpm add @guildedjs/api`
- `bun add @guildedjs/api`

## Contributing

Expand Down
3 changes: 2 additions & 1 deletion packages/create-guilded-app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@ Create a guilded.js bot with ease in under a minute.
## Usage

- `npm init guilded-app <project-name>`
- `yarn create guilded-app <project-name>`
- `pnpm create guilded-app <project-name>`
- `npm init guilded-app <project-name>`
- `bun create guilded-app <project-name>`

## Contributing

Expand Down
2 changes: 2 additions & 0 deletions packages/gil/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ You can install this package from [NPM](https://www.npmjs.com/package/@guildedjs

- `npm install @guildedjs/gil guilded.js`
- `yarn add @guildedjs/gil guilded.js`
- `pnpm add @guildedjs/gil guilded.js`
- `bun add @guildedjs/gil guilded.js`

## Guide

Expand Down
4 changes: 3 additions & 1 deletion packages/guilded.js/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,17 @@ client.login();

### Using `create-guilded-app`

- `npm init guilded-app <project-name>`
- `yarn create guilded-app <project-name>`
- `pnpm create guilded-app <project-name>`
- `npm init guilded-app <project-name>`
- `bun create guilded-app <project-name>`

### Manual Installation

- `npm install guilded.js`
- `yarn add guilded.js`
- `pnpm add guilded.js`
- `bun add guilded.js`

## 📃 Documentation

Expand Down

0 comments on commit b204d66

Please sign in to comment.