From b4809c5ed3ed130a4e7d3d5d2a21f5b1ae15e319 Mon Sep 17 00:00:00 2001 From: pancho Date: Sun, 4 Sep 2016 09:44:12 +0200 Subject: [PATCH] Update notes on Example API server . Update dirname . Drop explanation of features present in v1 . Describe current behaviour (v2) --- pixiecore/README.api.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/pixiecore/README.api.md b/pixiecore/README.api.md index ae3e28b..5c13d9c 100644 --- a/pixiecore/README.api.md +++ b/pixiecore/README.api.md @@ -179,13 +179,11 @@ Provide a proxied cloud-config and an unproxied other URL. ### Example API server There is a very small example API server implementation in the -`example` subdirectory. This sample server is not production-quality +`api-example` subdirectory. This sample server is not production-quality code (e.g. it uses panic for error handling), but should be a -reasonable starting point nonetheless. It implements a reduced form of -Pixiecore's static mode: you give it a kernel, initrd and commandline -as flags, and it serves those for all boot requests it -receives. Unlike Pixiecore's builtin static mode, the sample server -can only boot one initrd image. +reasonable starting point nonetheless. It will instruct pixecore +to boot Tiny Core Linux' kernel and initrd(s), +directly from upstream servers. ## Deprecated features