Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
portableant authored Feb 10, 2022
1 parent 277aa3c commit a5c00de
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,24 @@ polls a random json endpoint from the collection database and
then assembles a tweet with:

* Link to record
* The image of the artwork
* The title of the artwork
* An image of the artwork
* The title(s) of the artwork
* The maker(s) of the artwork
* Accession number

This currently pulls just from the works in Prints and Drawings with a picture
attached, this may change.

The bot tweets at https://twitter.com/fitzArtBot

## How this works

To make this work, a Twitter App needs to be generated with elevated access to the V2 API (read and write) - apply for access from essential after generation.
Once you have set up the twitter account, you need to set the 4 keys referred to in the R script as secrets in the github repo settings. Then the action will be executed every 6 hours and send a tweet.

The endpoint from which JSON is retrieved can be found at https://data.fitzmuseum.cam.ac.uk and is also used to run https://random.fitzmuseum.cam.ac.uk

## License

GPL V3
GPL V3 for code
Content within the Fitz API that this calls data from is CC-0 for metadata, CC-BY-NC-ND for images.

0 comments on commit a5c00de

Please sign in to comment.