Skip to content

Commit 8338759

Browse files
author
delphidabbler
committed
Corrected and clarified README.md
1 parent 4083197 commit 8338759

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

csdb/README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,15 @@ All of the snippets have been tested: some received basic testing while others h
88

99
## History
1010

11-
Version 1 was designed exclusively for use with _DelphiDabbler [CodeSnip](https://github.com/delphidabbler/codesnip)_ and was downloaded by the program directly from a web service on DelphiDabbler.com.
11+
Version 1 was designed exclusively for use with _DelphiDabbler [CodeSnip](https://github.com/delphidabbler/codesnip)_ (v4.15.1 and earlier) and was downloaded by the program directly from a web service on DelphiDabbler.com.
1212

13-
Version 2 is designed to be able to be used by other applications in addition to _CodeSnip_. This version is **not** backwards compatible with version 1.
13+
Version 2 is designed to be able to be used by other applications in addition to _CodeSnip_ (v4.16.0 or later). This version is **not** backwards compatible with version 1.
1414

1515
## Using the Collection
1616

17-
When used with _CodeSnip_, v4.16.0 or later is required.
17+
Anyone is welcome to write applications or web pages that access the snippets in the collection, subject to the terms of the license (see below). You should read the collection's documentation which explains the file format in detail.
1818

19-
Anyone is welcome to write applications or web pages that access the snippets in the collection. You should read the collection's documentation which explains the file format in detail.
20-
21-
> **WARNING:** Implementors must not read the collection data directly from this GitHub repository - that could generate more than the permitted amount of traffic. Instead you must download a release from the _Releases_ tab and either distribute the collection with the application or host it on a web server.
19+
> **WARNING:** Implementors **must not** read the collection data directly from this GitHub repository - that could generate more than the permitted amount of traffic. Instead you must download a release from the _Releases_ tab and either distribute the collection with the application or host it on a web server.
2220
2321
## Documentation
2422

@@ -30,8 +28,8 @@ Releases can be found on the `releases` tab on the GitHub project page.
3028

3129
Each release comprises two zip files, as follows (replace `X.Y.X` in the file names with the release version number):
3230

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.
31+
* `csdb-vX.Y.Z-data.zip` - Contains all the data in the collection. Required by applications that access the collection.
32+
* `csdb-vX.Y.Z-docs.zip` - Contains the documentation developers need to understand the structure of the data.
3533

3634
## Change Log
3735

0 commit comments

Comments
 (0)