@yigitahmetsahin/workflow-ts 1.0.6 → 1.1.1

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.
Files changed (2) hide show
  1. package/README.md +36 -0
  2. package/package.json +5 -5
package/README.md CHANGED
@@ -3,7 +3,9 @@
3
3
  A simple, extensible TypeScript workflow engine supporting serial and parallel work execution with full type inference.
4
4
 
5
5
  [![npm version](https://badge.fury.io/js/%40yigitahmetsahin%2Fworkflow-ts.svg)](https://www.npmjs.com/package/@yigitahmetsahin/workflow-ts)
6
+ [![CI](https://github.com/yigitahmetsahin/workflow-ts/actions/workflows/ci.yml/badge.svg)](https://github.com/yigitahmetsahin/workflow-ts/actions/workflows/ci.yml)
6
7
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
8
+ [![TypeScript](https://img.shields.io/badge/TypeScript-5.3+-blue.svg)](https://www.typescriptlang.org/)
7
9
 
8
10
  ## Features
9
11
 
@@ -250,6 +252,40 @@ Time ─────────────────────────
250
252
  └──────────────┘
251
253
  ```
252
254
 
255
+ ## Development
256
+
257
+ ```bash
258
+ # Install dependencies
259
+ npm install
260
+
261
+ # Run tests
262
+ npm test
263
+
264
+ # Run tests in watch mode
265
+ npm run test:watch
266
+
267
+ # Build the library
268
+ npm run build
269
+
270
+ # Type check
271
+ npm run lint
272
+ ```
273
+
274
+ ## Contributing
275
+
276
+ 1. Fork the repository
277
+ 2. Create your feature branch (`git checkout -b feat/amazing-feature`)
278
+ 3. Commit your changes using [Conventional Commits](https://www.conventionalcommits.org/):
279
+ - `feat:` for new features (minor version bump)
280
+ - `fix:` for bug fixes (patch version bump)
281
+ - `feat!:` or `BREAKING CHANGE:` for breaking changes (major version bump)
282
+ 4. Push to the branch (`git push origin feat/amazing-feature`)
283
+ 5. Open a Pull Request
284
+
285
+ This project uses [Release Please](https://github.com/googleapis/release-please) for automated releases. When your PR is merged:
286
+ - A release PR is automatically created/updated
287
+ - Merging the release PR publishes to npm with provenance
288
+
253
289
  ## License
254
290
 
255
291
  MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@yigitahmetsahin/workflow-ts",
3
- "version": "1.0.6",
3
+ "version": "1.1.1",
4
4
  "description": "A simple, extensible TypeScript workflow engine supporting serial and parallel work execution with full type inference",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -44,12 +44,12 @@
44
44
  },
45
45
  "homepage": "https://github.com/yigitahmetsahin/workflow-ts#readme",
46
46
  "devDependencies": {
47
- "tsup": "^8.0.0",
48
- "typescript": "^5.3.0",
49
- "vitest": "^2.0.0"
47
+ "tsup": "^8.5.1",
48
+ "typescript": "^5.9.3",
49
+ "vitest": "^4.0.17"
50
50
  },
51
51
  "engines": {
52
- "node": ">=18"
52
+ "node": ">=24"
53
53
  },
54
54
  "publishConfig": {
55
55
  "access": "public"