m3ters-solid

Introducing m3ters-solid, a Solid-js toolkit meticulously crafted to empower developers with seamless management of complex cryptographic strings within the M3tering Protocol.

This versatile library empowers developers with:

• Seamless Integration: Effortlessly incorporate m3ters-solid components and functions into your Solid-js projects, streamlining development and reducing complexity.

• Protocol Adherence: Interact with M3tering Protocol elements confidently, ensuring compliance with protocol-specific requirements and best practices.

Featured Solid Components

M3ter Alias: Transform Unwieldy Identifiers

Effortlessly convert those eye-straining crypto strings into captivating and user-friendly aliases, seamlessly integrated within your React applications. Representing IDs in a way you can actually remember.

M3ter Head: Unique SVG Avatars

Generate unique and captivating SVG avatars that serve as visual representations for device DIDs and blockchain addresses, enhancing user engagement and brand recognition.

Installation Options

m3ters-solid offers flexible installation methods to cater to your preferred workflow:

1. Using a Package Manager:

Open your terminal or command prompt and navigate to your project's root directory. Then, execute the following command:

• npm: npm i --save m3ters-solid
• yarn: yarn add m3ters-solid
• bun bun install m3ters-solid

If you prefer a package manager other than npm or yarn, you can also try:

• pnpm: pnpm install m3ters-solid
• Bower: bower install m3ters-solid

2. CDN Link:

• Include the following script tag in your HTML file:

<script src="https://unpkg.com/m3ters@latest/dist/m3ters.min.js"></script>

3. Direct Download:

• Access the m3ters-solid releases on GitHub: here
• Download the latest .zip or .tar.gz file containing the library source code.
• Extract the contents into your project's directory.
• Import components directly from the extracted files.

Usage

Added the Solid-js components from m3ters-solid into code via named imports

import { M3terAlias, M3terHead } from "m3ters-solid";

See M3ter Alias and M3ter Head for more usage documentation.

Compatibility

The library was developed, tested and is guaranteed to function properly on

• bun 1.2.2
• npm: 11.0.0
• solid-js: 1.9.4

Example App

Check out the my example GitHub repo, ichristwin/demo-m3ters. You could also experience the live implementation of at https://m3ters.ichristwin.com

Other projects using m3ters-solid

Contributing

See the contributing docs for more information on how to contribute code.

Licensing

You are free to embed under the terms of the CC0 1.0 Universal License.