Add skeletal specs
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
This commit is contained in:
@@ -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
|
||||
Reference in New Issue
Block a user