mart-w/serum-spec
1
0
Fork 0
mirror of https://github.com/serum-errors/serum-spec.git synced 2024-11-22 05:04:48 +01:00
Code Issues Packages Projects Releases Wiki Activity

intro touchup

Browse source
This commit is contained in:
Eric Myhre 2022-03-31 23:58:20 +02:00
parent de8f755d0b
commit 80dc65aaea
1 changed files with 13 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -1,13 +1,19 @@
Serum Errors 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: The goals are:
- to have observable, serializable, cross-langauge errors; - to have observable, serializable, cross-langauge errors;
- to have human readable, and also search-engine friendly errors; - to have human readable, and also search-engine friendly errors;
- and to promote rigorous error handling, and be amenable to static analysis. - 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: In short:
```json ```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 How Errors Should Be
-------------------- --------------------