Skip to content

Commit d93b92c

Browse files
authored
docs: update CLI naming to capiscio (consolidation)
* chore: Bump version to 2.4.0 * docs: Add v2.4.0 changelog entry * docs: update CLI naming to capiscio (consolidation)
1 parent a9965f0 commit d93b92c

2 files changed

Lines changed: 13 additions & 8 deletions

File tree

.github/workflows/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# GitHub Actions Workflows
22

3-
This directory contains the CI/CD workflows for the capiscio-cli project.
3+
This directory contains the CI/CD workflows for the `capiscio-node` project (npm package: `capiscio`).
4+
5+
Core binaries are published from `capiscio-core` releases: https://github.com/capiscio/capiscio-core/releases
46

57
## Workflows
68

CONTRIBUTING.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
1-
# Contributing to CapiscIO CLI
1+
# Contributing to CapiscIO CLI (Node.js Wrapper)
22

3-
Thank you for your interest in contributing to CapiscIO CLI! This document provides guidelines and information for contributors.
3+
Thank you for your interest in contributing to the CapiscIO CLI wrapper! This repository is `capiscio-node`, and the published npm package name is `capiscio`.
4+
5+
!!! note "Where the binaries come from"
6+
This project downloads the `capiscio-core` GitHub Release binaries at runtime. Core binaries are published from https://github.com/capiscio/capiscio-core.
47

58
## 🚀 Quick Start
69

710
1. Fork the repository
8-
2. Clone your fork: `git clone https://github.com/your-username/capiscio-cli.git`
11+
2. Clone your fork: `git clone https://github.com/your-username/capiscio-node.git`
912
3. Install dependencies: `npm install`
1013
4. Create a feature branch: `git checkout -b feature/your-feature-name`
1114
5. Make your changes
@@ -43,7 +46,7 @@ git push origin main
4346

4447
#### 2. Create Draft Release
4548

46-
1. Go to [GitHub Releases](https://github.com/capiscio/capiscio-cli/releases)
49+
1. Go to [GitHub Releases](https://github.com/capiscio/capiscio-node/releases)
4750
2. Click "Create a new release"
4851
3. **Important**: Create as **Draft** (do not publish yet)
4952
4. Set tag version (e.g., `v1.2.3`)
@@ -54,7 +57,7 @@ git push origin main
5457
#### 3. Wait for Binary Upload
5558

5659
1. The **Build and Release Binaries** workflow will trigger automatically
57-
2. Monitor the [Actions tab](https://github.com/capiscio/capiscio-cli/actions)
60+
2. Monitor the [Actions tab](https://github.com/capiscio/capiscio-node/actions)
5861
3. Wait for all binaries to be built and uploaded (~10-15 minutes)
5962
4. Verify assets appear in the draft release:
6063
- `capiscio-linux-x64.tar.gz`
@@ -97,8 +100,8 @@ git push origin main
97100
### Installation
98101

99102
```bash
100-
git clone https://github.com/capiscio/capiscio-cli.git
101-
cd capiscio-cli
103+
git clone https://github.com/capiscio/capiscio-node.git
104+
cd capiscio-node
102105
npm install
103106
```
104107

0 commit comments

Comments
 (0)