@lppedd/kotlinx-charset 0.0.4 → 0.1.2

package/README.md

@@ -3,6 +3,7 @@
 ![Build status](https://github.com/lppedd/kotlinx-charset/workflows/Build/badge.svg)
 ![MIT license](https://img.shields.io/github/license/lppedd/kotlinx-charset)
 ![Kotlin 2.1.20](https://img.shields.io/badge/kotlin-2.1.20-blue.svg?logo=kotlin)
+[![Maven Central](https://img.shields.io/maven-central/v/com.lppedd.kotlinx-charset/core)](https://mvnrepository.com/artifact/com.lppedd.kotlinx-charset)
 
 Minimal charset support for Kotlin Multiplatform.
 
@@ -12,7 +13,19 @@ See [CHANGELOG.md](./CHANGELOG.md).
 
 ### Supported Kotlin platforms
 
-All Kotlin platforms are supported, except for Android.
+All Kotlin platforms are supported, except for Android Native.
+
+### Design considerations
+
+**kotlinx-charset** aims to be straightforward for existing JDK consumers.  
+It replicates parts of the JDK's `Charset` API, albeit with more restrictions.
+
+The core types you will work with are:
+
+- `XCharset` - describes a character set
+- `XCharsetDecoder` - decodes a byte sequence into characters
+- `XCharsetEncoder` - encodes characters into a byte sequence
+- `XCharsetRegistrar` - a registry and lookup service for obtaining `XCharset` instances
 
 ## core
 
@@ -27,7 +40,7 @@ private val registrar = XCharsetRegistrar()
 registrar.registerCharset(YourCharset())
 
 // Retrieve and use a charset
-val charset = registrar.getCharset("yourCharsetName")
+val charset = registrar.getCharset("YourCharsetName")
 val decoder = charset.newDecoder()
 val encoder = charset.newEncoder()
 ```
@@ -37,8 +50,8 @@ val encoder = charset.newEncoder()
 The `ebcdic` module adds support for:
 
 ```text
-IBM037  IBM939
-IBM273  IBM1047
+IBM037  IBM939   IBM1390
+IBM273  IBM1047  IBM1399
 IBM297  IBM1141
 IBM930  IBM1147
 ```
@@ -47,7 +60,7 @@ You can register supported EBCDIC charsets to your `XCharsetRegistrar`
 via the `provideCharsets` function.
 
 ```kotlin
-import com.github.lppedd.kotlinx.charset.ebcdic.provideCharsets as provideEbcdicCharsets
+import com.lppedd.kotlinx.charset.ebcdic.provideCharsets as provideEbcdicCharsets
 
 // Your shared charset registry
 private val registrar = XCharsetRegistrar()

package/kotlinx-charset-exported.d.ts

@@ -1,14 +1,11 @@
 type Nullable<T> = T | null | undefined
-export declare function getCharset(charsetName: string): XCharset;
-export declare function decode(charsetName: string, bytes: Uint8Array): string;
-export declare function encode(charsetName: string, value: string): Uint8Array;
 export declare interface XCharset {
     readonly name: string;
     readonly aliases: Array<string>;
     newDecoder(): XCharsetDecoder;
     newEncoder(): XCharsetEncoder;
     readonly __doNotUseOrImplementIt: {
-        readonly "com.github.lppedd.kotlinx.charset.exported.XCharset": unique symbol;
+        readonly "com.lppedd.kotlinx.charset.exported.XCharset": unique symbol;
     };
 }
 export declare interface XCharsetDecoder {
@@ -16,7 +13,7 @@ export declare interface XCharsetDecoder {
     setReplacement(newReplacement: Nullable<string>): void;
     reset(): void;
     readonly __doNotUseOrImplementIt: {
-        readonly "com.github.lppedd.kotlinx.charset.exported.XCharsetDecoder": unique symbol;
+        readonly "com.lppedd.kotlinx.charset.exported.XCharsetDecoder": unique symbol;
     };
 }
 export declare interface XCharsetEncoder {
@@ -24,6 +21,10 @@ export declare interface XCharsetEncoder {
     setReplacement(newReplacement: Nullable<Uint8Array>): void;
     reset(): void;
     readonly __doNotUseOrImplementIt: {
-        readonly "com.github.lppedd.kotlinx.charset.exported.XCharsetEncoder": unique symbol;
+        readonly "com.lppedd.kotlinx.charset.exported.XCharsetEncoder": unique symbol;
     };
-}
+}
+export declare function getCharsets(): Array<XCharset>;
+export declare function getCharset(charsetName: string): XCharset;
+export declare function decode(charsetName: string, bytes: Uint8Array): string;
+export declare function encode(charsetName: string, value: string): Uint8Array;