From 29e4c2cc63c8ebb61d097db7c73955109c87b395 Mon Sep 17 00:00:00 2001 From: pancho horrillo Date: Tue, 30 Apr 2019 16:59:28 +0200 Subject: [PATCH] Add skeletal specs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Roberto Abdelkader Martínez Pérez --- spec/README.md | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 spec/README.md diff --git a/spec/README.md b/spec/README.md new file mode 100644 index 0000000..6b6df8f --- /dev/null +++ b/spec/README.md @@ -0,0 +1,57 @@ +# The Name of the Game + + + +# The Game of the Name +MAYBE: (ref to TeXbook) + +Kapow! + +KAPOW! + +kapow + +TODO: Rationale/Purpose/Why? +TODO: Definition +TODO: Intro to Architecture + + +# API +## Spec'ing the endpoints + +## Usage Example + +## Test Suite Notes + + +# Framework +## Commands +Any compliant implementation of Kapow! must provide these commands: + +### `kapow` +This implements the server, yaddayadda + +#### Example + +### `kroute` +TODISCUSS: maybe consider using `kapow route` instead + +#### Example + +### `request` + +#### Example + +### `response` + +#### Example + +## Full-fledged example (TODO: express it more simply) + + +## Test Suite Notes + +# Server + + +## Test Suite Notes