swixter 0.0.3 → 0.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +44 -0
- package/dist/cli/index.js +563 -489
- package/package.json +7 -4
package/README.md
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
# Swixter
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/swixter)
|
|
4
|
+
[](https://github.com/dawnswwwww/swixter/actions/workflows/test.yml)
|
|
5
|
+
[](https://github.com/dawnswwwww/swixter/actions/workflows/release.yml)
|
|
4
6
|
[](https://opensource.org/licenses/MIT)
|
|
5
7
|
[](https://nodejs.org)
|
|
6
8
|
|
|
@@ -338,6 +340,48 @@ Future plans for Swixter:
|
|
|
338
340
|
- [ ] Web UI for profile management
|
|
339
341
|
- [ ] Cloud sync for profiles (optional)
|
|
340
342
|
|
|
343
|
+
## Contributing
|
|
344
|
+
|
|
345
|
+
Contributions are welcome! Here's how to get started:
|
|
346
|
+
|
|
347
|
+
### Development Setup
|
|
348
|
+
|
|
349
|
+
```bash
|
|
350
|
+
# Clone the repository
|
|
351
|
+
git clone https://github.com/dawnswwwww/swixter.git
|
|
352
|
+
cd swixter
|
|
353
|
+
|
|
354
|
+
# Install dependencies
|
|
355
|
+
bun install
|
|
356
|
+
|
|
357
|
+
# Run in development mode
|
|
358
|
+
bun run cli:dev
|
|
359
|
+
|
|
360
|
+
# Run tests
|
|
361
|
+
bun test
|
|
362
|
+
|
|
363
|
+
# Build the project
|
|
364
|
+
bun run build
|
|
365
|
+
```
|
|
366
|
+
|
|
367
|
+
### Release Process
|
|
368
|
+
|
|
369
|
+
Swixter uses a semi-automated release process:
|
|
370
|
+
|
|
371
|
+
1. **Update CHANGELOG.md** with your changes under `[Unreleased]`
|
|
372
|
+
2. **Run release command**:
|
|
373
|
+
```bash
|
|
374
|
+
bun run release:patch # For bug fixes (0.0.4 → 0.0.5)
|
|
375
|
+
bun run release:minor # For new features (0.0.4 → 0.1.0)
|
|
376
|
+
bun run release:major # For breaking changes (0.0.4 → 1.0.0)
|
|
377
|
+
```
|
|
378
|
+
3. **GitHub Actions** automatically:
|
|
379
|
+
- Runs tests on Linux/macOS/Windows
|
|
380
|
+
- Publishes to npm
|
|
381
|
+
- Creates GitHub Release with changelog
|
|
382
|
+
|
|
383
|
+
See [CLAUDE.md](CLAUDE.md) for detailed development documentation.
|
|
384
|
+
|
|
341
385
|
## License
|
|
342
386
|
|
|
343
387
|
MIT License - see [LICENSE](LICENSE)
|