Add API documentation
[jackhill/qmk/firmware.git] / docs / api_overview.md
1 # QMK API
2
3 The QMK API provides an asynchronous API that Web and GUI tools can use to compile arbitrary keymaps for any keyboard supported by [QMK](http://qmk.fm/). The stock keymap template supports all QMK keycodes that do not require supporting C code. Keyboard maintainers can supply their own custom templates to enable more functionality.
4
5 ## App Developers
6
7 If you are an app developer interested in using this API in your application you should head over to [Using The API](api_docs.md).
8
9 ## Keyboard Maintainers
10
11 If you would like to enhance your keyboard's support in the QMK Compiler API head over to the [Keyboard Support](reference_configurator_support.md) section.
12
13 ## Backend Developers
14
15 If you are interested in working on the API itself you should start by setting up a [Development Environment](api_development_environment.md), then check out [Hacking On The API](api_development_overview.md).