Skip to content

Commit

Permalink
remove build step add contribution steps to readme to concure with ne…
Browse files Browse the repository at this point in the history
…w publish workflow
  • Loading branch information
rootedbox committed Jul 12, 2024
1 parent 2827834 commit 61fefc5
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 4 deletions.
3 changes: 0 additions & 3 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,6 @@ jobs:
- name: Install dependencies
run: npm install

- name: Run build (if you have a build step)
run: npm run build

- name: Publish to npm
run: npm publish
env:
Expand Down
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,25 @@ npm start

## 🤝 Contributing

We’d love your help! Fork the repo, make some changes, and send over a pull request.
We’d love your help! Fork the repo, checkout the `pre-release` branch, make some changes, and send over a pull request. If you want to use the code for your local usage instead of installing it globally, follow these steps:

1. **Clone your forked repo:**
```sh
git clone https://github.com/your-username/command-ai.git
cd command-ai
```
2. **Checkout the `pre-release` branch:**
```sh
git checkout pre-release
```
This branch is where we merge all the new features and bug fixes before they are released.
3. **Link the project locally:**
```sh
npm link
```
After these steps, you can use the commands (ai, aic, aiq, etc.) from your local development environment without installing the package globally.



## 📜 License

Expand Down

0 comments on commit 61fefc5

Please sign in to comment.