diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..c4c7aea --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,12 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +## [0.1.0] - 2020-06-01 + +* Initial Release + diff --git a/README.md b/README.md index 82e1b65..229c369 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,6 @@ in Crystal. - [Installation](#installation) - [Usage](#usage) -- [API](./docs/api.md) - [Supported Tags](#supported-tags) - [Limitations](#limitations) - [Community](#community) @@ -130,7 +129,7 @@ end Deserialization also respects default values of variables: -``` +```crystal require "cbor" struct A @@ -150,7 +149,7 @@ the CBOR document will be stored in a `Hash(String, CBOR::Type)`. On serialization, any keys inside `cbor_unmapped` will be serialized and appended to the current cbor map. -``` +```crystal require "cbor" struct A @@ -173,12 +172,12 @@ supported properties: - **nil_as_undefined**: if `true`, emits a `nil` value as undefined (by default nil emits `null`) -``` -require "json" +```crystal +require "cbor" @[CBOR::Serializable::Options(emit_nulls: true)] class A - include JSON::Serializable + include CBOR::Serializable @a : Int32? end ``` @@ -204,7 +203,11 @@ While this library supports lengths expressed as a `UInt64`, it must not exceed ## Community -TODO: Write development instructions here +If you're stuck and need help, if you have any questions, or if you simply want +to stay up to date with the latest news and developments, you can subscribe to +the [crystal-cbor mailing list][mailing-list]. + +If you found an issue, you can [open an issue on the ticket tracker][tickets]. ## Contributing diff --git a/src/cbor.cr b/src/cbor.cr index 8a45102..c3c33ef 100644 --- a/src/cbor.cr +++ b/src/cbor.cr @@ -2,7 +2,6 @@ require "big" require "./cbor/**" -# TODO: Write documentation for `CBOR` module CBOR VERSION = "0.1.0"