https://github.com/cypherpoet/alphabetencoder

A library to encode and decode integers from base alphabets of characters.
https://github.com/cypherpoet/alphabetencoder

algorithms base62-decoding base62-encoding swift swift-algorithms swift-decoding swift-encoding swift-libraries swift-package-manager swift-world-domination

Last synced: 4 days ago
JSON representation

A library to encode and decode integers from base alphabets of characters.

• Host: GitHub
• URL: https://github.com/cypherpoet/alphabetencoder
• Owner: CypherPoet
• License: mit
• Created: 2022-05-18T16:11:45.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-05-25T15:46:37.000Z (over 2 years ago)
• Last Synced: 2024-10-12T22:36:20.601Z (about 1 month ago)
• Topics: algorithms, base62-decoding, base62-encoding, swift, swift-algorithms, swift-decoding, swift-encoding, swift-libraries, swift-package-manager, swift-world-domination
• Language: Swift
• Homepage: https://cypherpoet.github.io/AlphabetEncoder/documentation/alphabetencoder
• Size: 2.29 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# AlphabetEncoder



    

    

    

    

    

    

    

    

    

      

    

    

        

    



A library to encode and decode integers from base alphabets of characters.


## 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:

```swift

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.

```swift

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](https://developer.apple.com/documentation/docc) (see [Apple's guidance for more details about creating DocC content](https://developer.apple.com/documentation/docc/api-reference-syntax)).

To build and preview the documentation output, follow the instructions for the [here](https://github.com/apple/swift-docc-plugin#previewing-documentation) for the `Swift-DocC Plugin `.

If you're using VSCode, there's also a [task configuration](./.vscode/tasks.json) that will handle this directly from the editor 💪

## 🏷 License

`AlphabetEncoder` is available under the MIT license. See the [LICENSE file](./LICENSE) for more info.