turkce-utils 0.1.0 → 0.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 +16 -0
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,6 +1,7 @@
1
1
  # turkce-utils
2
2
 
3
3
  [![CI](https://github.com/fatihdogann/turkce-utils/actions/workflows/ci.yml/badge.svg)](https://github.com/fatihdogann/turkce-utils/actions/workflows/ci.yml)
4
+ [![npm](https://img.shields.io/npm/v/turkce-utils.svg)](https://www.npmjs.com/package/turkce-utils)
4
5
  [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
5
6
  [![Runtime dependencies: 0](https://img.shields.io/badge/runtime_dependencies-0-brightgreen.svg)](#development)
6
7
 
@@ -225,6 +226,21 @@ npm run build # tsc -> dist/
225
226
  Every module has a matching test in `test/`. The library has **zero runtime
226
227
  dependencies**.
227
228
 
229
+ ### Releasing
230
+
231
+ Versions are published from GitHub Actions using npm **trusted publishing**
232
+ (OIDC), so no long-lived npm token is stored anywhere. Bump the version and push
233
+ a matching tag:
234
+
235
+ ```bash
236
+ npm version patch # or minor / major
237
+ git push --follow-tags
238
+ ```
239
+
240
+ [`.github/workflows/publish.yml`](.github/workflows/publish.yml) checks that the
241
+ tag matches `package.json`, runs the typecheck and the tests, and publishes with
242
+ a provenance attestation. It can also be started manually as a dry run.
243
+
228
244
  ## Developer
229
245
 
230
246
  **Mehmet Fatih Doğan** — Software Developer.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "turkce-utils",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Zero-dependency TypeScript helpers for Turkish text: slugify, Turkish-aware case & sort, title case, number-to-words, syllables and Ateşman readability — plus a CLI.",
5
5
  "keywords": [
6
6
  "turkish",
@@ -37,7 +37,7 @@
37
37
  }
38
38
  },
39
39
  "bin": {
40
- "turkce": "./dist/cli.js"
40
+ "turkce": "dist/cli.js"
41
41
  },
42
42
  "files": [
43
43
  "dist",