Skip to content

Commit

Permalink
Better documentation for landing page
Browse files Browse the repository at this point in the history
  • Loading branch information
linkedupbits committed Apr 26, 2021
1 parent d63f1c2 commit 3d221cf
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,24 @@ The intent of these standards is to provide FSC members and the wider Australian
a common definition of the information needed to satisfy the obligations, and a common, well defined format to transmit
and disseminate the required data between associated entities.

To assist with industry acceptance of these Data Standards, they are being released under an open source licence.
To assist with industry acceptance of these Data Standards, they are being released under an [open source licence](/LICENCE).

## Defined Data Standards
This repository defines three Data Standards:
- Target Market Determinataion (TMD)
- Dealings (transactions)
- Complaints

- [Target Market Determinataion (TMD)](Canonical/TargetMarketDeterminations.md)
- [Dealings (Transactions)](Canonical/Dealings.md)
- [Complaints](Canonical/Complaints.md)

## Repo Structure
- The Canonical Folder contains the logical data definitions
- The Implementation Folder contains the format specific implementations of the logical data definition
- The "Canonical" Folder contains the logical data definitions:
- [Target Market Determinataion (TMD)](Canonical/TargetMarketDeterminations.md)
- [Dealings (Transactions)](Canonical/Dealings.md)
- [Complaints](Canonical/Complaints.md)
- The "Implementation" Folder contains the format specific implementations of the logical data definition:
- [XML (Comprehensive)](Implementations/Xml/README.md)
- [CSV (TMD Only)](Implementations/CSV/README.md)
- [JSON (Not yet started)](Implementations/JSON/README.md)

### Version control, branching and releases
To support the standards development process, this repository will define a branch per future version.
All future standard version will be commited to this banch, until ratified, upon which they will be merged into the Main branch.

0 comments on commit 3d221cf

Please sign in to comment.