MycroftAI
/
mycroft-core
mirror of https://github.com/MycroftAI/mycroft-core.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Added more information on device pairing, and cleaned up API Key documentation further.

pull/15/head
Ryan Sipes 2016-05-20 16:52:52 -05:00
parent 4347e6e4d0
commit 63b09d516f
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -28,14 +28,20 @@ By default the Mycroft software is configured to use Cerberus, upon any request
Once signed and a device is paired, the unit will use our API keys for services, such as the STT (Speech-to-Text) API. It also uses allows you to use our API keys for weather, Wolfram-Alpha, and various other skills. Once signed and a device is paired, the unit will use our API keys for services, such as the STT (Speech-to-Text) API. It also uses allows you to use our API keys for weather, Wolfram-Alpha, and various other skills.
Pairing information generated by registering with Cerberus is stored in:
`~./mycroft/identity/identity.json` <b><-- DO NOT SHARE THIS WITH OTHERS!</b>
It's useful to know the location of the identity file when troubleshooting device pairing issues.
## Using Mycroft without Cerberus. ## Using Mycroft without Cerberus.
If you do not wish to use our service, you may insert your own API keys into the configuration files listed below in <b>configuraion</b>. If you do not wish to use our service, you may insert your own API keys into the configuration files listed below in <b>configuraion</b>.
The place to insert the API key looks like the following: The place to insert the API key looks like the following:
`[WeatherSkill] `[WeatherSkill]`
api_key = ""`
`api_key = ""`
Put the relevant key in between the quotes and Mycroft Core should begin to use the key immediately. Put the relevant key in between the quotes and Mycroft Core should begin to use the key immediately.