Skip to content

Commit a596e89

Browse files
author
delphidabbler
committed
Add section describing release files to README.md
1 parent 7ae6228 commit a596e89

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

csdb/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,15 @@ Anyone is welcome to write applications or web pages that access the snippets in
2424

2525
The collection data format is fully documented in the file `collection-format.html` in the `docs` directory.
2626

27+
## Releases
28+
29+
Releases can be found on the `releases` tab on the GitHub project page.
30+
31+
Each release comprises two zip files, as follows (replace `X.Y.X` in the file names with the release version number):
32+
33+
* `csdb-vX.Y.Z-data.zip` - contains all the data in the collection required by applications that access that collection.
34+
* `csdb-vX.Y.Z-docs.zip` - contains the documentation developers need to understand the structure of the data.
35+
2736
## Change Log
2837

2938
The project's change log can be found in `CHANGELOG.md` in the collection's base directory.

0 commit comments

Comments
 (0)