From 56ecf51ce08153614c03916a5e090c0457b0aa20 Mon Sep 17 00:00:00 2001 From: Kian-Meng Ang Date: Thu, 24 Feb 2022 22:04:32 +0800 Subject: [PATCH] Fix typos and markdown --- CHANGELOG.md | 14 +++++++------- README.md | 6 +++--- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f8f76b1..74c8826 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -55,42 +55,42 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. - Dialyzer enhancements - Test and documentation enhancements -## [1.2.X] - 2018.02.24 +## [1.2.X] 2018.02.24 - Remove support for system event tracing for `notify` action (unnecessary) - Move internal modules under managers namespace for better documentation - Add `subscribed?` function to check subscriptions -## [1.1.X] - 2018.02.21 +## [1.1.X] 2018.02.21 - Optional system events which notify the `eb_action_called` topic for the actions: `notify`, `register_topic`, `unregister_topic`, `subscribe`, `unsubscribe`, `mark_as_completed`, `mark_as_skipped` - Add public exist? function to Topic, Watcher, and Store - Check existence of topic in a blocking manner - Register/Unregister topic in a blocking manner -## [1.0.0] - 2018.01.23 +## [1.0.0] 2018.01.23 - Move build and notify blocks into EventSource - Add use keyword for Source for developer friendly require and aliases - Split GenServers and Services - Move utility functions into its own module - Add addons section to README -- Switch to microseconds when auto event structuring with `EventSource` to increase compability with Zipkin and Datadog APM +- Switch to microseconds when auto event structuring with `EventSource` to increase compatibility with Zipkin and Datadog APM - Error topic introduced for dynamic event builder/notifier with `EventSource`. Now you can pass `:error_topic` key, EvetSource automatically check the result of execution block for `{:error, _}` tuple and create an event structure for the given `:error_topic`. - Add elixir formatter config to format code -## [0.9.0] - 2018.01.06 +## [0.9.0] 2018.01.06 - Add `source` attribute to increase traceability - Add optional configuration to Subscriber to use the same module/function with different configurations to process the event. The aim of this change is increasing re-useability of the subscriber with several configurations. For example, this will allow writing an HTTP consumer or an AWS lambda caller function with different configurations. -## [0.8.0] - 2018.01.06 +## [0.8.0] 2018.01.06 - Register/unregister topics on-demand (`EventBus.register_topic/1` and `EventBus.unregister/1`) - Add block/yield builder for Event with auto `initialized_at` and `occurred_at` attribute assignments - Add block/yield notifier for delivering/notifying events creation with same benefits of build block - Add changelog file -## [0.7.0] - 2018.01.06 +## [0.7.0] 2018.01.06 - Add `initialized_at` attribute diff --git a/README.md b/README.md index e147ff2..6041c8a 100644 --- a/README.md +++ b/README.md @@ -89,7 +89,7 @@ Traceable, extendable and minimalist event bus implementation for Elixir with bu - Traceable with optional attributes. Optional attributes compatible with opentracing platform. -- Minimal with required attributes(Incase, you want it work minimal use 3 required attributes to deliver your events). +- Minimal with required attributes(In case, you want it work minimal use 3 required attributes to deliver your events). ## Getting Started @@ -343,11 +343,11 @@ use EventBus.EventSource id = "some unique id" topic = :user_created -error_topic = :user_create_erred # optional (incase error tuple return in yield execution, it will use :error_topic value as :topic for event creation) +error_topic = :user_create_erred # optional (in case error tuple return in yield execution, it will use :error_topic value as :topic for event creation) transaction_id = "tx" # optional ttl = 600_000 # optional source = "my event creator" # optional -EventBus.register_topic(topic) # incase you didn't register it in `config.exs` +EventBus.register_topic(topic) # in case you didn't register it in `config.exs` params = %{id: id, topic: topic, transaction_id: transaction_id, ttl: ttl, source: source, error_topic: error_topic} EventSource.notify(params) do