Skip to content
This repository has been archived by the owner on Oct 13, 2020. It is now read-only.

Commit

Permalink
docs(repo): add docs for expected structure
Browse files Browse the repository at this point in the history
add documenation around the expected structure for the file input
structure with link to example

GH-8
  • Loading branch information
blake-newman committed Feb 20, 2020
1 parent a3104b8 commit a7c2f2e
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,7 @@ jobs:
input: './annotations.json'
title: 'Annotate Files'
```

### Input file structure

The expected structure for the input is defined [here in the source](https://github.com/Attest/annotations-action/blob/master/src/annotation.ts), for an example please look at [`annotations.json`](https://github.com/Attest/annotations-action/blob/master/annotations.json).

0 comments on commit a7c2f2e

Please sign in to comment.