diff --git a/README.md b/README.md index 52d557e..d13bcab 100644 --- a/README.md +++ b/README.md @@ -1 +1,10 @@ -# gene-pool-backend \ No newline at end of file +# gene-pool-backend + +This ASP.NET based back-end controls the data flow for transcribing YouTube videos into a text-based format. + +In order to run this repository, paste in your Azure Storage connection string into appsettings.json, and send a POST request with a JSON body to {{url}}/api/speechtotext/transcribe_link. + +Example: +{ + "url": "https://www.youtube.com/watch?v=..." +}