Plugin README Files

Every EA plugin must include two README files inside its version folder:

1.0.0/
├── README-EN.md    ← English documentation
└── README-AR.md    ← Arabic documentation

These files are displayed on the plugin's store page in Motanamy. They contain two parts: a YAML frontmatter block with structured metadata, and a Markdown body with a full description.

Frontmatter

The frontmatter block sits at the top of the file between --- delimiters.

---
image: images,logo.png
name: My Plugin
description: A short one-paragraph description shown in search results and the store listing.
type: 0
store:
  - _9575144742244
bloger:
  - _2317365083
versions:
  - version: 1.0.0
    number: 0
    items:
      - 'Initial release'
faq: []
features: []
slides:
  - images,screenshot1.png
  - images,screenshot2.png
cost:
  year: 10
  month: 1
  own: 50
---

Frontmatter Fields

Field	Type	Description
image	string	Logo image path. Use comma instead of / — e.g. images,logo.png means images/logo.png
name	string	Plugin display name
description	string	Short description shown in store listings and search
type	number	Plugin category type (0 = general)
store	string[]	List of store IDs where this plugin is available
bloger	string[]	List of blogger/author IDs associated with this plugin
versions	array	Version history (see below)
faq	array	List of FAQ entries (can be empty)
features	array	List of feature entries (can be empty)
slides	string[]	Screenshot image paths, shown as a slideshow on the store page. Same comma path format as image
cost.year	number	Annual subscription price
cost.month	number	Monthly subscription price
cost.own	number	One-time ownership price

versions Structure

versions:
  - version: 1.0.0      # semantic version string
    number: 0           # version counter (matches versionNumber in setting.json)
    items:              # changelog items for this version
      - 'Initial release'
      - 'Added dashboard widget'

Image Path Format

Motanamy uses a comma (,) instead of / in image paths inside the frontmatter:

# Correct
image: images,logo.png       # → images/logo.png
slides:
  - images,screenshot1.png   # → images/screenshot1.png

# Wrong
image: images/logo.png

Markdown Body

Below the frontmatter, write a full Markdown description of your plugin. This is displayed as the main content of the store listing page.

---
# ... frontmatter above
---

A brief intro paragraph about what the plugin does.

## Key Features

### 1. Feature Name
Description of the feature.

### 2. Another Feature
Description.

## Use Cases

Describe who should use this plugin and in what situations.

Complete Example

README-EN.md

---
image: images,logo.png
name: Cashier
description: A point-of-sale management program for shops, restaurants, hotels, and online stores. Easy to use and customizable.
type: 0
store:
  - _9575144742244
  - _87847854244
bloger:
  - _2317365083
versions:
  - version: 1.0.0
    number: 0
    items:
      - 'start application'
faq: []
features: []
slides:
  - images,products.png
  - images,addItem.png
  - images,bills.png
cost:
  year: 10
  month: 1
  own: 50
---

The Cashier plugin is an essential tool for managing points of sale efficiently.

## Main Features

### 1. Ease of Use
Simple interface suitable for all user levels.

### 2. Operations Management
Manage sales, inventory, invoices, and reports in one place.

### 3. Reports & Statistics
Generate sales, inventory, and revenue reports to analyze performance.

README-AR.md — same structure, all text in Arabic:

---
image: images,logo.png
name: كاشير
description: برنامج كاشير هو برنامج يستخدم لإدارة نقاط البيع في المحلات التجارية والمطاعم والفنادق.
type: 0
store:
  - _9575144742244
bloger:
  - _2317365083
versions:
  - version: 1.0.0
    number: 0
    items:
      - 'بدء التطبيق'
faq: []
features: []
slides:
  - images,products.png
cost:
  year: 10
  month: 1
  own: 50
---

يعد برنامج الكاشير من الأدوات المهمة لإدارة نقاط البيع.

## المزايا الرئيسية

### 1. سهولة الاستخدام
واجهة سهلة الاستخدام مناسبة لجميع المستويات.