diff --git a/README.md b/README.md
index 3e91aa41..fb039aec 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# MetaCodable
-[](https://swiftylab.github.io/MetaCodable/documentation/metacodable/)
+[](https://swiftpackageindex.com/SwiftyLab/MetaCodable/main/documentation/metacodable)
[](https://badge.fury.io/gh/SwiftyLab%2FMetaCodable)
[](https://img.shields.io/badge/Swift-5-DE5D43)
[](https://img.shields.io/badge/Platforms-all-sucess)
@@ -21,7 +21,7 @@ Supercharge `Swift`'s `Codable` implementations with macros.
- Allows to create flattened model for nested `CodingKey` values with ``CodedAt(_:)`` and ``CodedIn(_:)``.
- Allows to create composition of multiple `Codable` types with ``CodedAt(_:)`` passing no arguments.
- Allows to provide default value in case of decoding failures with ``Default(_:)``.
-- Allows to create custom decoding/encoding strategies with ``HelperCoder`` and using them with ``CodedBy(_:)``. i.e. ``LossySequenceCoder`` etc.
+- Allows to create custom decoding/encoding strategies with ``HelperCoder`` and using them with ``CodedBy(_:)``. i.e. ``LossySequenceCoder`` and types from ``HelperCoders`` module.
- Allows to ignore specific properties from decoding/encoding with ``IgnoreCoding()``, ``IgnoreDecoding()`` and ``@IgnoreEncoding()``.
- Allows to use camel-case names for variables according to [Swift API Design Guidelines](https://www.swift.org/documentation/api-design-guidelines/#general-conventions), while enabling a type to work with different case style keys with ``CodingKeys(_:)``.
- Allows to ignore all initialized properties of a type from decoding/encoding with ``IgnoreCodingInitialized()`` unless explicitly asked to decode/encode by attaching any coding attributes, i.e. ``CodedIn(_:)``, ``CodedAt(_:)``,
@@ -219,7 +219,23 @@ init(field: String = "some") {
-See the full [documentation](https://swiftylab.github.io/MetaCodable/documentation/metacodable/) for API details and advanced use cases.
+
+ Use or create custom helpers to provide custom decoding/encoding.
+
+Library provides following helpers that address common custom decoding/encoding needs:
+
+- `LossySequenceCoder` to decode only valid data while ignopring invalid data in a sequence, instead of traditional way of failing decoding entirely.
+- `ValueCoder` to decode `Bool`, `Int`, `Double`, `String` etc. basic types even if they are represented in some other type, i.e decoding `Int` from `"1"`, decoding boolean from `"yes"` etc.
+- Custom Date decoding/encoding with UNIX timestamp (`Since1970DateCoder`) or date formatters (`DateCoder`, `ISO8601DateCoder`).
+- `Base64Coder` to decode/encode data in base64 string representation.
+
+And more, see the full documentation for [`HelperCoders`](https://swiftpackageindex.com/SwiftyLab/MetaCodable/main/documentation/helpercoders) for more deatils.
+
+You can even create your own by conforming to `HelperCoder`.
+
+
+
+See the full documentation for [`MetaCodable`](https://swiftpackageindex.com/SwiftyLab/MetaCodable/main/documentation/metacodable) and [`HelperCoders`](https://swiftpackageindex.com/SwiftyLab/MetaCodable/main/documentation/helpercoders), for API details and advanced use cases.
## Contributing
diff --git a/Sources/HelperCoders/PropertyWrapperCoder.swift b/Sources/HelperCoders/PropertyWrapperCoder.swift
index 62b53bde..7d5a90e0 100644
--- a/Sources/HelperCoders/PropertyWrapperCoder.swift
+++ b/Sources/HelperCoders/PropertyWrapperCoder.swift
@@ -5,7 +5,7 @@ import MetaCodable
///
/// This type can be used to reuse existing property
/// wrappers with custom decoding/encoding with
-/// ``MetaCodable`` generated implementations.
+/// ``/MetaCodable`` generated implementations.
public struct PropertyWrapperCoder: HelperCoder {
/// Creates a new instance of ``/MetaCodable/HelperCoder`` that decodes/encodes
/// using existing property wrappers.
diff --git a/Sources/MetaCodable/HelperCoders/HelperCoder.swift b/Sources/MetaCodable/HelperCoders/HelperCoder.swift
index 75cd48fe..a3c31e37 100644
--- a/Sources/MetaCodable/HelperCoders/HelperCoder.swift
+++ b/Sources/MetaCodable/HelperCoders/HelperCoder.swift
@@ -218,14 +218,14 @@ public extension HelperCoder {
try self.encode(value, to: encoder)
}
- /// Encodes given value of the ``Coded`` type to the provided `container`
+ /// Encodes given value of the ``HelperCoder/Coded`` type to the provided `container`
/// at the specified `key`.
///
- /// By default, of the ``Coded`` value confirms to `Encodable`, then
+ /// By default, of the ``HelperCoder/Coded`` value confirms to `Encodable`, then
/// encoding is performed. Otherwise no data written to the encoder.
///
/// - Parameters:
- /// - value: The ``Coded`` value to encode.
+ /// - value: The ``HelperCoder/Coded`` value to encode.
/// - container: The container to write data to.
/// - key: The key to write data at.
///
@@ -239,14 +239,14 @@ public extension HelperCoder {
try self.encode(value, to: container.superEncoder(forKey: key))
}
- /// Encodes given optional value of the ``Coded`` type to the provided
+ /// Encodes given optional value of the ``HelperCoder/Coded`` type to the provided
/// `container` at the specified `key`, if it is not `nil`.
///
- /// By default, of the ``Coded`` value confirms to `Encodable`, then
+ /// By default, of the ``HelperCoder/Coded`` value confirms to `Encodable`, then
/// encoding is performed. Otherwise no data written to the encoder.
///
/// - Parameters:
- /// - value: The optional ``Coded`` value to encode.
+ /// - value: The optional ``HelperCoder/Coded`` value to encode.
/// - container: The container to write data to.
/// - key: The key to write data at.
///