https://github.com/sultansagitov/simplesix64

Encode scheme for 6 bit symbols
https://github.com/sultansagitov/simplesix64

6bit case-insensitive encoding java maven

Last synced: 3 days ago
JSON representation

Encode scheme for 6 bit symbols

• Host: GitHub
• URL: https://github.com/sultansagitov/simplesix64
• Owner: sultansagitov
• License: gpl-3.0
• Created: 2024-09-11T12:14:47.000Z (22 days ago)
• Default Branch: main
• Last Pushed: 2024-09-17T18:57:08.000Z (16 days ago)
• Last Synced: 2024-09-17T23:20:35.327Z (16 days ago)
• Topics: 6bit, case-insensitive, encoding, java, maven
• Language: Java
• Homepage:
• Size: 30.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SimpleSix64

**SimpleSix64** is an encoding library designed to extend Base64 encoding with a broader set of characters, including case-insensitive letters and a variety of symbols. This library is useful for applications needing a custom encoding scheme that supports a wider range of characters.

## Features

- **Extended Character Set**: Supports a rich set of symbols beyond the standard Base64.

- **Case Insensitivity**: Encoding and decoding processes handle case insensitivity.

## Installation

### Clone the Repository

To get started, clone the repository from GitHub:

```bash

git clone https://github.com/sultansagitov/simplesix64.git

```

### Build and Install Locally

Navigate into the project directory and build the project using Maven:

```bash

cd simplesix64

mvn clean install

```

This will install the library into your local Maven repository.

### Adding to Your Project

Add the following dependency to your `pom.xml` to use SimpleSix64 in your Maven project:

```xml

    net.result.simplesix64

    simple64

    1.0.0

```

## Usage

### Encoding

To encode a string, use the `encode` method. This method converts the input string into a custom encoded format using the defined character set.

```java

import net.result.simplesix64.SimpleSix64;

public class EncodingExample {

    public static void main(String[] args) {

        String data = "Hello, World!";

        byte[] encoded = SimpleSix64.encode(data);

        System.out.println("Encoded: " + new String(encoded));

    }

}

```

## License

This project is licensed under the GNU General Public License v3.0. See the [LICENSE](LICENSE) file for details.