Skip to content

Commit 49b4373

Browse files
committed
Update docs for @demoscript/cli package
- Fix package name: demoscript-cli → @demoscript/cli - Add build script options (--install, --publish) - Update CHANGELOG with v1.1.7 changes
1 parent 19f77a6 commit 49b4373

File tree

2 files changed

+40
-6
lines changed

2 files changed

+40
-6
lines changed

CHANGELOG.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,27 @@ All notable changes to DemoScript will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [1.1.7] - 2026-01-26
9+
10+
### Changed
11+
12+
- **Simplified npm package** - Reduced package size from 5.8MB to 1.5MB by bundling dependencies
13+
- **Package renamed** - Now published as `@demoscript/cli` (scoped package)
14+
15+
### Added
16+
17+
- **Build script improvements**
18+
- `--install` - Install locally to `~/.local/bin`
19+
- `--install -g` - Install globally (uses sudo if needed)
20+
- `--publish [patch|minor|major]` - Bump version and publish to npm
21+
- **esbuild bundling** - All dependencies bundled into single file for faster startup
22+
23+
### Technical
24+
25+
- Removed `@demoscript/shared` and `@demoscript/builder` as npm dependencies (bundled instead)
26+
- Only `vite` remains as external dependency (for dev server)
27+
- Clean dist before build (removes old tsc artifacts)
28+
829
## [0.2.0] - 2026-01-10
930

1031
### Added

README.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Browse all examples at [demoscript.app/gallery](https://demoscript.app/gallery/)
4646
### npm (recommended)
4747

4848
```bash
49-
npm install -g demoscript-cli
49+
npm install -g @demoscript/cli
5050
```
5151

5252
Then run with:
@@ -58,7 +58,7 @@ demoscript serve ./my-demo
5858
Or run directly with npx (no install required):
5959

6060
```bash
61-
npx demoscript-cli serve ./my-demo
61+
npx @demoscript/cli serve ./my-demo
6262
```
6363

6464
### Linux Packages
@@ -800,7 +800,7 @@ See [ROADMAP.md](ROADMAP.md) for the full improvement guide including architectu
800800
801801
```bash
802802
# Clone repository
803-
git clone https://github.com/your-org/demoscript
803+
git clone https://github.com/aximcode/demoscript
804804
cd demoscript
805805
806806
# Install dependencies
@@ -810,17 +810,30 @@ npm install
810810
npm run dev
811811
812812
# Build all packages
813-
npm run build
813+
./build.sh
814+
815+
# Build and install locally (to ~/.local/bin)
816+
./build.sh --install
817+
818+
# Build and install globally (uses sudo if needed)
819+
./build.sh --install -g
820+
821+
# Build and publish to npm
822+
./build.sh --publish # patch version bump
823+
./build.sh --publish minor # minor version bump
824+
825+
# Build and start dev server
826+
./build.sh --serve
814827
815828
# Run tests
816829
cd packages/cli && npm test
817830
cd packages/ui && npm test
818831
819832
# Build RPM package (requires: dnf install rpm-build)
820-
./scripts/build-packages.sh rpm
833+
./build.sh --rpm
821834
822835
# Build DEB package (requires: apt install dpkg-dev debhelper)
823-
./scripts/build-packages.sh deb
836+
./build.sh --deb
824837
```
825838

826839
See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed development guidelines.

0 commit comments

Comments
 (0)