Customizing your Chainlet

Application Configuration with chainlet.yml

In the root directory of every Chainlet application, there is a chainlet.yml file. This configuration file defines the application’s metadata, including:

  • Project name

  • Version

  • Author

  • Description

  • Other configuration details

Configure Name & Description

title: Example APP
description: Demo chainlet that shows how to configure Chainlet Meta

  • title → the Chainlet’s name

  • description → a short summary of the Chainlet

  • Both fields are displayed in the Chainlet Store and visible to end users.

logo: logo.png

Sets the application logo shown in the Chainlet Store.

Configure chainlet.md

  • chainlet.md is a markdown file dedicated to describing your application.

  • After uploading, it is used as the official description page in the Chainlet Store.

Configure Screenshots

  • Screenshots are displayed on the details page of your Chainlet in the Store.

  • Define them in chainlet.yml like so:

screenshots:
  - 0.png
  - 1.png
  - 2.png

Example

A properly configured Chainlet will appear in the Chainlet Store with:

  • Title & description

  • Logo

  • Description page (chainlet.md)

  • Screenshots gallery

PreviousCombined ApplicationsNextManaging your Chainlet release

Last updated