From 0a71282310f8f8a41469d55b75f54854aae64119 Mon Sep 17 00:00:00 2001 From: Josh Tynjala Date: Fri, 2 Sep 2022 06:15:18 -0700 Subject: [PATCH] README: explain which types are available --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a69ab81..08fa1be 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,14 @@ AMF binary data format readers and writers for for [OpenFL](https://openfl.org/) and [Feathers UI](https://feathersui.com/), written in [Haxe](https://haxe.org/). -Supports reading and writing raw AMF data, and Local Shared Object _.sol_ files, using OpenFL's `ByteArray` class. +Contains the following types for AMF input and output. + +- `AMFReader`: Reads AMF0 or AMF3 objects from a `ByteArray` +- `AMFWriter`: Writes AMF0 or AMF3 objects to a `ByteArray` +- `SolReader`: Reads Flash Local Shared Object data from a `ByteArray` +- `SolWriter`: Writes Flash Local Shared Object data to a `ByteArray` +- `AMFEcmaArray`: An associative array that may contain both integer and string keys. Like a combination of the `Array` type and an anonymous structure. +- `AMFDictionary`: Similar to the `Map` type, but keys are not restricted to a single type. ## Minimum Requirements