Uploading an app

If you don't already have an account on this site, you'll need to create one before uploading an app to the Garden. Make sure you have Kanso 0.1.4 or higher, then use the following command to upload your app:



        

Required properties

Before uploading an app to the Garden, you need to ensure you provide the following properties in your kanso.json file.

Icons

You must supply at least four icon sizes: 16x16, 48x48, 96x96, 128x128. No image processing happens after you upload the app to the garden, you are expected to properly format and scale your icons beforehand.

Icon sizes should be normalized, so they have the same visual weight. For information on what makes a good icon, see the guidance on supplying images from the Chrome Web Store.

{
    "attachments": ["icons", ...],
    "icons": {
        "16": "icons/app_icon_16.png",
        "48": "icons/app_icon_48.png",
        "96": "icons/app_icon_96.png",
        "128": "icons/app_icon_128.png"
    },
    "dependencies": {
        "attachments": null,
        ...
    },
    ...
}

Note: In the above example the icons are added as attachments before referencing the attachment paths for each icon size.

Categories

Each app must belong to at least one category (though preferably only one). If you're able to fit your app under an existing category that is much preferred to adding a new one.

{
    "categories": ["productivity"],
    ...
}

Descriptions

Apps require two descriptions: a short one used on the listing page and a long one used only on the details page. Note that the short description appears above the long one on the details page, so don't start the long description by repeating the short one.

{
    "description": "This is a short description",
    "long_description": "This is a much longer description, possibly with multiple paragraphs.\n\nSeparate paragraphs with two newline characters.",
    ...
}

Promotional images

All apps should have at least a small promotional image 210x150 pixels. This will be used to display your app on listings pages. More sizes may be added in the future.

{
    "attachments": ["images", ...],
    "promo_images": {
        "small": "images/promo_small.png"
    },
    "dependencies": {
        "attachments": null,
        ...
    }
    ...
}
Note: In the above example the promo images are added as attachments before referencing the attachment paths for each size.

Screenshots

You must provide at least one screenshot with the app, though two or three would be better. These images will be displayed on the app details page and will be constrained to a 640x400 space. These images are not processed before displaying, so consider resizing them appropriately before uploading.

{
    "attachments": ["images", ...],
    "screenshots": [
        "images/screenshot1.png",
        "images/screenshot2.png",
        "images/screenshot3.png"
    ],
    "dependencies": {
        "attachments": null,
        ...
    }
    ...
}
Note: In the above example the screenshots are added as attachments before referencing the attachment paths for each screenshot.

Website

Please provide your GitHub repository as your website. This provides the best experience for the market, end users, and other developers. Just add the url property in your kanso.json file. It will be displayed on the app detail page.

{
    "url": "https://github.com/kanso/garden"
    ...
}

Payment

App developers should be rewarded for their hard work. We have provided integration with flatter so you can receive payments for your app. No payment is forced on a user in a market, but flattr provides the best open model for payments currently. Another advantage is that international developers can partake of the benefits. Just add the flattr_user_id in your kanso.json file.

{
    "flattr_user_id": "myname"
    ...
}