8 Commits

Author SHA1 Message Date
Etan Kissling
d856d6ece5
Update readme for current API
The README file was describing an outdated way of defining serialization
formats. It was updated accordingly to match the current API.

- New format declaration using `setReader` and `setWriter`
  and mandatory `PreferredOutput` type declaration,
  as introduced in f9a1121b8733eb75e624ab59f8d79e707f15f76f.
- Removal of `fileExt` declaration, which was never implemented.
- Removal of format-specific `dontSerialize` pragma
  as well as the `serialize` pragma, which were never implemented.
- Rename `serializedFields` macro to `setSerializedFields`,
  to keep up with 60613bac5db2bd7914d484874201f31b3f318165.
- Remove rename functionality in `setSerializedFields`,
  which was never implemented.
- A couple updated argument lists and typo corrections.
2022-06-19 15:18:41 +07:00
Jacek Sieka
11a8aa64d2 enable --styleCheck:usages 2021-12-07 00:33:04 +02:00
Ștefan Talpalaru
5213d397f9
CI: refactor Nim compiler caching (#35) 2021-06-03 01:59:50 +02:00
Zahary Karadjov
f9a1121b87
Make the flavors support optional when defining formats
Other changes:

* The format declarations have been broken down in multiple
  parts. This makes it possible to structure the implementation
  libraries in a way such that the format name is accessible even
  when importing only reader or writer modules.

* Flavors lead to more complicated Reader and Writer types.
  Instead of requiring the user to write down long type names
  such as `JsonReader[DefaultFlavor]`, it's now possible to refer
  to the reader and writer type of each format using expressions
  such as `Json.Reader` and `Json.Writer`.

* Fixed a typo (PreferredOutput)
2021-03-19 04:04:14 +02:00
jangko
dd115dca5b
add github action 2020-12-24 11:34:38 +07:00
Ștefan Talpalaru
e6c59d86be
add AppVeyor badge 2019-08-24 05:22:46 +02:00
Ștefan Talpalaru
171dbde4b1
fix README 2019-07-13 17:05:06 +02:00
Zahary Karadjov
0546444876 WIP README 2019-06-24 17:36:18 +03:00