Merge pull request #18 from zenchantlive/docs/update-readme-no-npm
docs: update README to reflect no npm publish yet
This commit is contained in:
commit
a25fbfc9d0
1 changed files with 11 additions and 24 deletions
35
README.md
35
README.md
|
|
@ -1,7 +1,5 @@
|
|||
# BeadBoard
|
||||
|
||||
[](https://www.npmjs.com/package/beadboard)
|
||||
[](https://github.com/zenchantlive/beadboard/actions)
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
[](https://github.com/zenchantlive/beadboard/stargazers)
|
||||
|
||||
|
|
@ -33,7 +31,7 @@ This one command installs the BeadBoard driver skill, enabling your AI agents to
|
|||
|
||||
### Install from Source
|
||||
|
||||
BeadBoard is currently installed by cloning the repository and installing locally:
|
||||
BeadBoard is installed by cloning the repository and installing locally:
|
||||
|
||||
```bash
|
||||
# Clone the repository
|
||||
|
|
@ -48,6 +46,8 @@ This installs:
|
|||
- `beadboard` - Dashboard launcher
|
||||
- `bd` - Beads CLI for task management
|
||||
|
||||
> **Note**: BeadBoard is not published to npm yet. We may publish it in the future if there's demand. For now, install from source as shown above.
|
||||
|
||||
### Verify Installation
|
||||
|
||||
```bash
|
||||
|
|
@ -130,7 +130,10 @@ This command installs the BeadBoard driver skill, enabling your AI agents to:
|
|||
### For Human Users
|
||||
|
||||
```bash
|
||||
npm install -g beadboard
|
||||
# Clone and install from source
|
||||
git clone https://github.com/zenchantlive/beadboard.git
|
||||
cd beadboard
|
||||
npm install -g .
|
||||
beadboard start
|
||||
```
|
||||
|
||||
|
|
@ -269,34 +272,18 @@ DAG-oriented workspace for execution decisions:
|
|||
git clone https://github.com/zenchantlive/beadboard.git
|
||||
cd beadboard
|
||||
npm install
|
||||
npm install -g .
|
||||
```
|
||||
|
||||
### Global CLI Install
|
||||
|
||||
```bash
|
||||
npm install -g beadboard
|
||||
```
|
||||
This makes `beadboard` and `bd` commands available globally.
|
||||
|
||||
**Alternative: Platform-specific wrappers**
|
||||
|
||||
If you prefer not to install globally via npm, you can use the platform-specific wrappers.
|
||||
|
||||
POSIX (Linux/macOS):
|
||||
```bash
|
||||
bash ./install/install.sh
|
||||
```
|
||||
|
||||
Windows (PowerShell):
|
||||
```powershell
|
||||
powershell -ExecutionPolicy Bypass -File .\install\install.ps1
|
||||
```
|
||||
|
||||
Both wrappers install shims at:
|
||||
- `~/.beadboard/bin/bb`
|
||||
- `~/.beadboard/bin/beadboard`
|
||||
|
||||
Runtime home:
|
||||
- `~/.beadboard/runtime/<version>`
|
||||
- `~/.beadboard/runtime/current.json`
|
||||
|
||||
### Development Setup
|
||||
|
||||
```bash
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue