@cremini/skillpack 1.1.3 → 1.1.4

package/README.md

@@ -1,83 +1,99 @@
-# SkillPack.sh - Pack AI Skills into Local Agents
+# SkillPack.sh — Pack AI Skills into Local Agents
 
 Skillpack by Cremini is built on the idea of distributed intelligence, much like cremini mushrooms that grow from a vast, interconnected mycelial network.
 
 ## Use Case
-The main use case is to **run local agents on your computer and integrate them with Slack or Telegram** so they can work for you and your team—operating entirely on your machine to keep all team data local and private, while continuously improving by learning new skills.
 
-If skills and tools are like LEGO pieces, a skill pack is the master piece that assembles them into a complete solution. Go to [skillpack.sh](https://skillpack.sh) to download skillpacks.Each Skill Pack should organize different skills to address a well-defined problem or complete specific tasks. For example, research a company by gathering information from various sources and create a PowerPoint presentation based on the findings.
+The main use case is to **run local agents on your computer and integrate them with Slack or Telegram** so they can work for you and your team — operating entirely on your machine to keep all team data local and private, while continuously improving by learning new skills.
 
-## Quick Start
+If skills and tools are like LEGO pieces, a SkillPack is the finished product that assembles them into a complete solution. Go to [skillpack.sh](https://skillpack.sh) to download ready-made packs.
+
+Each SkillPack organizes skills around a well-defined job — for example: research a company by gathering information from multiple sources and produce a PowerPoint presentation from the findings.
 
-### Create a Skill Pack Interactively
+---
+
+## Quick Start
 
-One command orchestrates [Skills](https://skills.sh) and tools into a Local Agent that users can download and run it on their own computer to get work done. It can also connect to chat platforms like Slack or Telegram, allowing you to easily send instructions to your local agent team anytime.
+### Create a new pack interactively
 
 ```bash
 npx @cremini/skillpack create
 ```
 
-Step-by-Step
+Step by step:
 
-1. Set the Pack name and description
-2. Add skills from a GitHub repos, URLs, or local paths
-3. Add prompts to orchestrate and organize skills you added to accomplish tasks
-4. (Optional) bundle the result as a zip
+1. Set the pack name and description.
+2. Add skills from GitHub repos, URLs, or local paths.
+3. Add prompts to tell the agent how to orchestrate those skills.
+4. Optionally package the result as a zip immediately.
 
-### Initialize with Configuration
+### Initialize from an existing config
 
 ```bash
-npx @cremini/skillpack init --config ./skillpack.json
-npx @cremini/skillpack init commic_explainer --config https://raw.githubusercontent.com/CreminiAI/skillpack/refs/heads/main/examples/commic_explainer.json
+# From a local file
+npx @cremini/skillpack create --config ./skillpack.json
+
+# From a remote URL (no directory = current directory)
+npx @cremini/skillpack create comic-explainer --config https://raw.githubusercontent.com/CreminiAI/skillpack/refs/heads/main/examples/comic_explainer.json
 ```
 
-Bootstrap a SkillPack using a local file or remote URL.
+Downloads and validates the config, installs all declared skills, and copies the start scripts — ready to run in one step.
 
-### Step-by-Step Commands
+### Run a pack
 
 ```bash
-# Add skills
-npx @cremini/skillpack skills add vercel-labs/agent-skills --skill frontend-design
-npx @cremini/skillpack skills add ./my-local-skills --skill local-helper
+npx @cremini/skillpack run
+npx @cremini/skillpack run ./comic-explainer
+```
+
+- If `skillpack.json` is missing, you are prompted to create one on the spot.
+- Any remote skills declared in the config but not yet installed are installed automatically.
+- The server starts and opens [http://127.0.0.1:26313](http://127.0.0.1:26313) in your browser.
 
-# Manage prompts
-npx @cremini/skillpack prompts add "Collect company data using Skill A, create charts from the data using Skill B, and compile the results into a PowerPoint using Skill C"
-npx @cremini/skillpack prompts list
+### Package a pack for distribution
 
-# Package the current app
-npx @cremini/skillpack build
+```bash
+npx @cremini/skillpack zip
 ```
 
-## Commands
+Produces `<pack-name>.zip` in the current directory.
+
+---
+
+## Skill Source Formats
+
+When adding skills through `create`, the source field accepts:
+
+```bash
+# GitHub shorthand
+vercel-labs/agent-skills --skill frontend-design
 
-| Command                  | Description                           |
-| ------------------------ | ------------------------------------- |
-| `create`                 | Create a skill pack interactively     |
-| `init`                   | Initialize from a config path or URL  |
-| `skills add <source>`    | Add one or more skills with `--skill` |
-| `skills remove <name>`   | Remove a skill                        |
-| `skills list`            | List installed skills                 |
-| `prompts add <text>`     | Add a prompt                          |
-| `prompts remove <index>` | Remove a prompt                       |
-| `prompts list`           | List all prompts                      |
-| `build`                  | Package the skill pack as a zip file  |
+# Full GitHub URL
+https://github.com/JimLiu/baoyu-skills/tree/main/skills --skill baoyu-comic
+
+# Local path
+./skills/my-local-skill
+```
+
+Multiple skill names from the same source can be listed comma-separated.
+
+---
 
 ## Zip Output
 
-The extracted archive looks like this:
+The archive produced by `zip` is intentionally minimal:
 
 ```text
-skillpack/
+<pack-name>/
 ├── skillpack.json       # Pack configuration
-├── skills/              # Collected SKILL.md files
-├── server/              # Runtime backend
-├── web/                 # Runtime web UI
-├── start.sh             # One-click launcher for macOS/Linux
-├── start.bat            # One-click launcher for Windows
-└── README.md            # Runtime guide
+├── skills/              # Installed skills
+├── start.sh             # One-click launcher for macOS / Linux
+└── start.bat            # One-click launcher for Windows
 ```
 
-### Run the Skill Pack
+The start scripts use `npx @cremini/skillpack run .` so Node.js is the only prerequisite — no pre-bundled server directory is included.
+
+### Run a distributed pack
 
 ```bash
 # macOS / Linux
@@ -87,11 +103,35 @@ skillpack/
 start.bat
 ```
 
-Running start.sh will open [http://127.0.0.1:26313](http://127.0.0.1:26313) in your browser. Just enter your API key to get started and enjoy!
+The browser opens [http://127.0.0.1:26313](http://127.0.0.1:26313) automatically. Enter your API key and start working.
+
+---
+
+## IM Integrations
+
+The runtime supports **Slack** and **Telegram** in addition to the built-in web UI. Configure them in `data/config.json` (created at runtime, not included in the zip):
+
+```json
+{
+  "adapters": {
+    "telegram": {
+      "token": "123456:ABC-DEF..."
+    },
+    "slack": {
+      "botToken": "xoxb-...",
+      "appToken": "xapp-..."
+    }
+  }
+}
+```
+
+See [docs/runtime/im-adapters.md](docs/runtime/im-adapters.md) for setup requirements.
+
+---
 
 ## Development
 
-For development details, see [Development Guide](docs/development.md).
+For build commands, CLI reference, and environment variables, see [Development Guide](docs/development.md).
 
 ## License