Documentation: New README

zooniverse / tove

Transcription Object Viewer/Editor: Backend API for ALICE Text Editor tool

https://alice.zooniverse.org/

2 stars 2 forks source link

Documentation: New README #95

Closed zwolf closed 5 months ago

zwolf commented 4 years ago

The readme needs some actual documentation in it. The gems this uses, how to interact with the API, which routes are available, how to authenticate, etc. Something in the style of https://github.com/zooniverse/messenger would be nice.

And for cryin' out loud, at least leave some of the quote.

zwolf commented 4 years ago

A tool like https://github.com/Apipie/apipie-rails might also be an option, but might be overkill for the tiny number of endpoints we've got.