From 80dc65aaea46bdcde10e783630b4594632662d6e Mon Sep 17 00:00:00 2001 From: Eric Myhre Date: Thu, 31 Mar 2022 23:58:20 +0200 Subject: [PATCH] intro touchup --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index aebff1d..0d33833 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,19 @@ Serum Errors ============ -"Serum" errors are a set of simple standards for errors, error handling, and error serialization. +"Serum" is a simple standard for errors and error serialization. + +Serum aims to be a common-sense, "just enough" standard -- easy to adopt, easy to extend, easy to describe. +It specifies enough to be meaningful, but not so much that it becomes complicated. The goals are: - to have observable, serializable, cross-langauge errors; - to have human readable, and also search-engine friendly errors; - and to promote rigorous error handling, and be amenable to static analysis. +Serum describes a simple format (canonically, in JSON), and a couple of conventions for using it. +(It can be other serial formats too. JSON is just clear and widely-known.) + In short: ```json @@ -18,6 +24,12 @@ In short: } ``` +You don't need any particular library to use Serum, and you don't need to be in any particular programming language. +It's easy to conform to Serum, with or without library support. + +Keep reading for more details, below. + + How Errors Should Be --------------------