diff --git a/README.md b/README.md index 6aba32c..b1a57c2 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,19 @@ -# speechmatics_python -Example script (supported) to help you integrate with our API +# Legacy V1 Python Example + +Example script (supported) to help you integrate with our legacy V1 API. This code was developed and tested with Python 2.7.12 and Python 3.5.2 This is an example script for uploading audio files and saving the transcript in a .json file +> NOTE: For information on how to use the current Speechmatics Realtime ASR API v2, +> see [speechmatics-python](https://github.com/speechmatics/speechmatics-python) repository. + + ## Requirements + You will need to have the requests module installed in your Python environment. + ``` pip install requests ``` @@ -16,4 +23,4 @@ pip install requests python ./speechmatics.py -a example.mp3 -l en-US -i $user_id -k $auth_token -o example.json ``` -In this example the script uploads 'example.mp3', transcribes it using our en-US speech to text product and saves the resulting transcription as 'example.json' when the job has completed. +In this example the script uploads `example.mp3`, transcribes it using our en-US speech to text product and saves the resulting transcription as `example.json` file when the job has completed.