Browse Source

Added a readme explaining the role of each API

Solomon Hykes 12 years ago
parent
commit
d64f105b44
1 changed files with 5 additions and 0 deletions
  1. 5 0
      docs/sources/api/README.md

+ 5 - 0
docs/sources/api/README.md

@@ -0,0 +1,5 @@
+This directory holds the authoritative specifications of APIs defined and implemented by Docker. Currently this includes:
+
+* The remote API by which a docker node can be queried over HTTP
+* The registry API by which a docker node can download and upload container images for storage and sharing
+* The index search API by which a docker node can search the public index for images to download