Skip to content

Commit 588b0b0

Browse files
committed
docs: drop the _kt suffix from the library and release name
Repo slug stays cobs_codec_kt; artifact/release identity is cobs_codec.
1 parent ee3f064 commit 588b0b0

3 files changed

Lines changed: 16 additions & 12 deletions

File tree

.github/workflows/release-aar.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,19 +30,19 @@ jobs:
3030
version="${GITHUB_REF_NAME#v}"
3131
if [ "$version" = "$GITHUB_REF_NAME" ]; then version="dev"; fi
3232
mkdir -p dist
33-
cp cobs/build/outputs/aar/cobs-release.aar "dist/cobs_codec_kt-${version}.aar"
33+
cp cobs/build/outputs/aar/cobs-release.aar "dist/cobs_codec-${version}.aar"
3434
echo "version=$version" >> "$GITHUB_OUTPUT"
3535
- name: Upload as workflow artifact
3636
uses: actions/upload-artifact@v7
3737
with:
38-
name: cobs_codec_kt-aar-release
38+
name: cobs_codec-aar-release
3939
path: dist/*.aar
4040
- name: Attach to GitHub release
4141
if: startsWith(github.ref, 'refs/tags/')
4242
uses: softprops/action-gh-release@v3
4343
with:
4444
files: dist/*.aar
45-
name: cobs_codec_kt ${{ steps.stage.outputs.version }}
45+
name: cobs_codec ${{ steps.stage.outputs.version }}
4646
body: |
4747
Pure-Kotlin **COBS / COBS-R** for Android, packaged as an `.aar`.
4848
@@ -51,5 +51,5 @@ jobs:
5151
5252
Add to your app:
5353
```kotlin
54-
implementation(files("libs/cobs_codec_kt-${{ steps.stage.outputs.version }}.aar"))
54+
implementation(files("libs/cobs_codec-${{ steps.stage.outputs.version }}.aar"))
5555
```

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Contributing to cobs_codec_kt
1+
# Contributing to cobs_codec (Kotlin/Android)
22

3-
Thanks for your interest in improving `cobs_codec_kt`!
3+
Thanks for your interest in improving `cobs_codec` (repository `cobs_codec_kt`)!
44

55
## Getting started
66

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
1-
# cobs_codec_kt
1+
# cobs_codec
2+
3+
_Kotlin / Android edition — Maven artifact `dev.firechip:cobs_codec`, repository
4+
[`cobs_codec_kt`](https://github.com/firechip/cobs_codec_kt) (the `_kt` suffix is
5+
just the repo slug)._
26

37
[![CI](https://github.com/firechip/cobs_codec_kt/actions/workflows/ci.yml/badge.svg)](https://github.com/firechip/cobs_codec_kt/actions/workflows/ci.yml)
48
[![Release](https://img.shields.io/github/v/release/firechip/cobs_codec_kt?sort=semver)](https://github.com/firechip/cobs_codec_kt/releases)
59
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
610

711
Pure-Kotlin **Consistent Overhead Byte Stuffing (COBS)** and **COBS/R** for
8-
Android, distributed as an `.aar`. It is the Kotlin sibling of the Dart
9-
[`cobs_codec`](https://pub.dev/packages/cobs_codec) package and produces
10-
byte-identical output (validated by 20,000-vector differential testing against
11-
the original reference implementation).
12+
Android, distributed as an `.aar`. It is the Kotlin/Android member of the
13+
Firechip COBS family (alongside the Dart
14+
[`cobs_codec`](https://pub.dev/packages/cobs_codec) on pub.dev) and produces
15+
byte-identical output (validated against the shared conformance vectors).
1216

1317
COBS encodes an arbitrary `ByteArray` into one that contains no zero (`0x00`)
1418
bytes, at a small, predictable cost (at most one extra byte per 254 bytes, plus
@@ -63,7 +67,7 @@ authentication:
6367

6468
```kotlin
6569
dependencies {
66-
implementation(files("libs/cobs_codec_kt-1.0.0.aar"))
70+
implementation(files("libs/cobs_codec-1.0.0.aar"))
6771
}
6872
```
6973

0 commit comments

Comments
 (0)