You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-28
Original file line number
Diff line number
Diff line change
@@ -2,19 +2,6 @@
2
2
3
3
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.
4
4
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
-
18
5
---
19
6
20
7
## 🧩 Introduction
@@ -25,22 +12,26 @@ Extensions are modular pieces of functionality that you can add to your InvoiceS
25
12
## 🚀 Getting Started
26
13
27
14
### Requirements
15
+
28
16
To develop an extension, you need the following:
17
+
29
18
- Basic knowledge of InvoiceShelf's API or extension architecture.
30
19
- GitHub, GitLab, or other Git hosting platforms for managing your extension.
31
20
32
21
### Repository Structure
22
+
33
23
Your extension repository should follow this structure:
34
24
35
25
> TBD
36
26
37
27
38
28
---
39
29
40
-
## ✍️ Creating an Extension
30
+
## ✍️ Adding an Extension to the InvoiceShelf markeplace
41
31
42
32
### 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:
44
35
45
36
```json
46
37
{
@@ -59,6 +50,14 @@ The `extension.json` file is a mandatory file that provides metadata about your
59
50
}
60
51
```
61
52
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
+
62
61
***Metadata Fields***
63
62
64
63
- name: A unique name for your extension.
@@ -71,19 +70,6 @@ The `extension.json` file is a mandatory file that provides metadata about your
71
70
- repository: URL of your extension's Git repository.
72
71
- download_url: Direct link to the downloadable package (ZIP file).
73
72
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.
0 commit comments