From 9240f1c609d8f013b75d70519d2c0695c0e1e518 Mon Sep 17 00:00:00 2001 From: Noccy Date: Thu, 13 Aug 2020 23:58:33 +0000 Subject: [PATCH] Updated flavorstash readme --- json/vape/flavorstash/README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/json/vape/flavorstash/README.md b/json/vape/flavorstash/README.md index 1c0475b..e116795 100644 --- a/json/vape/flavorstash/README.md +++ b/json/vape/flavorstash/README.md @@ -5,4 +5,37 @@ between different websites or applications. This could be used on a website by presenting the json data and allowing the user to copy it and paste it on another site. +## Use cases +* Any application or site where a list of flavorings is maintained. +## Implementation Suggestions +* For websites, make the json available to copy (to export) or paste and submit (to import). +* For applications, allowing both to save/load from file and clipboard is suggested. + +## Implementation Details +The schema is as simplified as possible, meaning only the `vendor` and `flavor` fields are +required for each record. + + [ + { "vendor":"TFA", "flavor":"Smooth" } + ] + +Additional application-specific data can be included: + + [ + { "vendor":"TFA", "flavor":"Smooth", "extra":{ "is_additive":true }} + ] + +### Standard Extra keys +The following keys are standardized and should not be used for any other purpose than specified. + +Application-specific data can (and should) be namespaced using dots, eg. `my_mixer_app.favorite`. + +| Key | Type | Description | +| ------------- | -------- | ----------------------------------------- | +| `g_ml` | decimal | The specific gravity in grams per 1ml | +| `is_additive` | bool | If `true` the flavor is an additive | + + + + \ No newline at end of file