Skip to content

Commit 790792e

Browse files
committed
add README.md file
1 parent 435182c commit 790792e

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

docs/extension_structure.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,9 @@ For an extension to be valid, one file of each type must be present in an extens
88
- my-extension
99
- my-extension.control
1010
- my-extension--0.0.1.sql
11+
- README.md
1112

12-
In the above example, the `my-extension` folder contains the extension files. Names of the files are important. The control file should be named `<extension_name>.control` and the script file should be named `<extension_name>--<extension_version>.sql`.
13+
In the above example, the `my-extension` folder contains the extension files. Names of the files are important. The control file should be named `<extension_name>.control` and the script file should be named `<extension_name>--<extension_version>.sql`. The readme file should be named `README.md` (case sensitive).
1314

1415
## Control Files
1516

@@ -76,3 +77,7 @@ You might have noticed a strange line at the beginning of the [`pgjwt-0.1.1.sql`
7677
### Update Scripts
7778

7879
Update scripts are used to update an installed extension. An update script should be named `<extension_name>--<old_version>--<new_version>.sql`. For example if version `1.0` of `my-extension` was published already and you want to publish a new version `1.1` you need to create `my-extension--1.0--1.1.sql`. Update scripts can create new database object or modify/delete existing objects created by the previous version of the extension.
80+
81+
## README.md File
82+
83+
README.md file contains documentation for the extension in the [markdown](https://en.wikipedia.org/wiki/Markdown) format. The documentation typically contains installation and usage instructions about the extension.

0 commit comments

Comments
 (0)