Skip to content

Latest commit

 

History

History
111 lines (76 loc) · 3.66 KB

README.md

File metadata and controls

111 lines (76 loc) · 3.66 KB
Raw

List of third-party add-ons

This repository is a public list of 3rd party integrations of the Tinify image optimization API (https://tinypng.com/developers) with other software.

The list is updated frequently and published on https://tinypng.com/third-party.

Adding your integration to the list

  1. Fork this repository
  2. Create a new file named {platform}-{descriptive name}.md
  3. Add your descriptions and links following the requirements below.
  4. Create a pull request.

Requirements

The file name must be formatted as {platform}-{descriptive name}.md in lower case. The platform corresponds to the platform field in the file itself. The descriptive name can be a short name of your work.

The file contains two parts:

  1. Structured YAML "front-matter" with some metadata.
  2. A short description of your solution.

Example:

File wordpress-plugin.md:

---
collection: Content management
platform: WordPress
type: Plugin
developer: Tinify
developer_url: https://tinypng.com/developers
price: Free
url: https://wordpress.org/plugins/tiny-compress-images/
---

Automatically optimizes user-uploaded images in the background. Also offers
advanced bulk optimization to compress your existing media library.

Fields required in front-matter

collection

Main category of the integration which must be one of:

  • Content management – for integrations with content management systems.
  • Desktop – for desktop software with a GUI.
  • Development – for command line tools, client libraries, integrations with programming languages or frameworks.
  • E-commerce – for integrations with webshops and e-commerce platforms.

platform

This is the name of the platform you created the solution for. Depending on the collection above this will be different. For example:

  • For content management systems it will be the name of the CMS.
  • For desktop software this is the name of the operating system.
  • For development tools you can specify the programming language or framework.
  • For e-commerce integrations this is the name of the e-commerce product.

type

This describes the type of solution. You may follow the naming convention of the platform that is being integrated with.

For example, add-ons for WordPress are officially called "plugins", so the type would be Plugin. For Magento integrations are officially called an "extension", so the type would be Extension.

developer

This is the full name of the software development agency or person that authored and maintains this third-party solution.

developer_url

This is a link to the homepage of the developer. Preferably this would be a location where users can contact you if they have any questions.

price

This is either Free or the price in the main currency that you charge users with, for example: $ 19.00.

url

This is the location of the download page for your third-party add-on. It should describe the solution and offer a way for the user to install or download it in order to add it to their platform.

Description

The description should contain the main features of your integration. For example, whether it supports resizing or preserving metadata, whether it optimizes images in the background, etcetera.

You could also provide more information about how it integrates exactly with the platform. For example, whether it optimizes images when they are uploaded by a user to the CMS, or whether they are optimized when the pages are published.

Please avoid describing what TinyPNG or TinyJPEG is. Feel free to include this information on your download page, though.

This description is preferably between 80 and 160 characters long.