Skip to content

Commit 0009ffc

Browse files
authored
Update README.md
1 parent 31f37c2 commit 0009ffc

File tree

1 file changed

+14
-28
lines changed

1 file changed

+14
-28
lines changed

README.md

+14-28
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,6 @@
22

33
Welcome to the official Extensions Repository for **InvoiceShelf**. This repository serves as a central hub for creating, managing, and submitting extensions to enhance the functionality of InvoiceShelf.
44

5-
## 📖 Table of Contents
6-
- [Introduction](#introduction)
7-
- [Getting Started](#getting-started)
8-
- [Requirements](#requirements)
9-
- [Repository Structure](#repository-structure)
10-
- [Creating an Extension](#creating-an-extension)
11-
- [Metadata File](#metadata-file)
12-
- [Code Structure](#code-structure)
13-
- [Submitting an Extension](#submitting-an-extension)
14-
- [Versioning and Updates](#versioning-and-updates)
15-
- [Extension Guidelines](#extension-guidelines)
16-
- [Support](#support)
17-
185
---
196

207
## 🧩 Introduction
@@ -25,22 +12,26 @@ Extensions are modular pieces of functionality that you can add to your InvoiceS
2512
## 🚀 Getting Started
2613

2714
### Requirements
15+
2816
To develop an extension, you need the following:
17+
2918
- Basic knowledge of InvoiceShelf's API or extension architecture.
3019
- GitHub, GitLab, or other Git hosting platforms for managing your extension.
3120

3221
### Repository Structure
22+
3323
Your extension repository should follow this structure:
3424

3525
> TBD
3626
3727

3828
---
3929

40-
## ✍️ Creating an Extension
30+
## ✍️ Adding an Extension to the InvoiceShelf markeplace
4131

4232
### Metadata File
43-
The `extension.json` file is a mandatory file that provides metadata about your extension. Below is a sample:
33+
34+
The `extensions.json` lists all available extensions for InvoiceShelf. Below is a sample:
4435

4536
```json
4637
{
@@ -59,6 +50,14 @@ The `extension.json` file is a mandatory file that provides metadata about your
5950
}
6051
```
6152

53+
To add your extension to the extensions.json file:
54+
55+
1. Fork the InvoiceShelf extensions repository.
56+
2. Add your extension's metadata to the extensions.json file.
57+
3. Submit a pull request (PR) with your changes.
58+
59+
> Once submitted, your extension will be reviewed for inclusion in the marketplace.
60+
6261
***Metadata Fields***
6362

6463
- name: A unique name for your extension.
@@ -71,19 +70,6 @@ The `extension.json` file is a mandatory file that provides metadata about your
7170
- repository: URL of your extension's Git repository.
7271
- download_url: Direct link to the downloadable package (ZIP file).
7372

74-
***Code Structure***
75-
76-
Write your extension's functionality in the src/ directory. Follow coding standards for [Your Project Name]. Include documentation in README.md and tests in the tests/ folder (if applicable).
77-
📝 Submitting an Extension
78-
79-
To submit your extension to the marketplace:
80-
81-
- Create a public repository on GitHub, GitLab, or similar.
82-
- Add a README.md and LICENSE file.
83-
- Create a PR in order to add your extension in the list
84-
85-
Once submitted, your extension will be reviewed for inclusion in the marketplace.
86-
8773
🔄 Versioning and Updates
8874

8975
- Tag releases in your repository using Git tags.

0 commit comments

Comments
 (0)