CypherPoet/AlphabetEncoder

Installation

Xcode Projects

Select File -> Swift Packages -> Add Package Dependency and enter https://github.com/CypherPoet/AlphabetEncoder.

Swift Package Manager Projects

You can add AlphabetEncoder as a package dependency in your Package.swift file:

let package = Package(
    //...
    dependencies: [
        .package(
            name: "AlphabetEncoder",
            url: "https://github.com/CypherPoet/AlphabetEncoder",
            .upToNextMinor(from: "0.3.0")
        ),
    ],
    //...
)

From there, refer to AlphabetEncoder as a "target dependency" in any of your package's targets that need it.

targets: [
    .target(
        name: "YourLibrary",
        dependencies: [
          "AlphabetEncoder",
        ],
        ...
    ),
    ...
]

Then simply import AlphabetEncoder wherever you’d like to use it.

🗺 Road Map

• Potentially add more base alphabets.

💻 Developing

Requirements

• Xcode 13.0+

📜 Creating & Building Documentation

Documentation is built with DocC (see Apple's guidance for more details about creating DocC content).

To build and preview the documentation output, follow the instructions for the here for the Swift-DocC Plugin .

If you're using VSCode, there's also a task configuration that will handle this directly from the editor 💪

🏷 License

AlphabetEncoder is available under the MIT license. See the LICENSE file for more info.

Package Metadata

Repository: CypherPoet/AlphabetEncoder

Homepage: https://cypherpoet.github.io/AlphabetEncoder/documentation/alphabetencoder

Stars: 0

Forks: 0

Open issues: 0

Default branch: main

Primary language: swift

License: MIT

Topics: algorithms, base62-decoding, base62-encoding, swift, swift-algorithms, swift-decoding, swift-encoding, swift-libraries, swift-package-manager, swift-world-domination

README: README.md