mirror of
https://github.com/zarzet/SpotiFLAC-Mobile.git
synced 2026-08-02 09:08:35 +02:00
docs(extensions): document the .sflx package suffix
This commit is contained in:
@@ -65,9 +65,14 @@ Package the contents—not their parent directory—as ZIP:
|
||||
|
||||
```bash
|
||||
cd my-extension
|
||||
zip -r ../my-extension.spotiflac-ext manifest.json index.js
|
||||
zip -r ../my-extension.sflx manifest.json index.js
|
||||
```
|
||||
|
||||
An extension package is a plain ZIP archive renamed to `.sflx`. The longer
|
||||
`.spotiflac-ext` suffix is the legacy alias; both are accepted everywhere
|
||||
(manual import, repo downloads) and the layout is identical. Use `.sflx` for
|
||||
new packages.
|
||||
|
||||
`manifest.json` and `index.js` must be unique files at the archive root.
|
||||
SpotiFLAC Mobile rejects traversal paths, symlinks, duplicate paths, oversized
|
||||
manifests, and archives whose extracted size exceeds the safety limit.
|
||||
@@ -182,7 +187,7 @@ Repository maintainers should publish a SHA-256 digest for every package:
|
||||
"version": "1.0.0",
|
||||
"description": "What this extension provides",
|
||||
"category": "metadata",
|
||||
"download_url": "https://example.com/my-extension.spotiflac-ext",
|
||||
"download_url": "https://example.com/my-extension.sflx",
|
||||
"sha256": "64-lowercase-hex-characters"
|
||||
}
|
||||
]
|
||||
@@ -192,7 +197,7 @@ Repository maintainers should publish a SHA-256 digest for every package:
|
||||
Generate the digest after building the package:
|
||||
|
||||
```bash
|
||||
sha256sum my-extension.spotiflac-ext
|
||||
sha256sum my-extension.sflx
|
||||
```
|
||||
|
||||
Store downloads with a published digest are written to a temporary file,
|
||||
|
||||
Reference in New Issue
Block a user