Skip to content

Commit ad97e48

Browse files
committed
feat: improve readme
1 parent 48272d9 commit ad97e48

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -536,6 +536,8 @@ config.debug = true
536536
(Proc) => called after publishing a notification
537537
- ```.on_error_publish = ->(exception, {payload:}) { payload.delay(...).publish! }```
538538
(Proc) => called when failed publishing a notification (delayed_job or similar can be used for retrying)
539+
- ```.skip_cache = false```
540+
(true/false*) => Allow to skip payload optimization (cache settings)
539541
- ```.transactions_max_buffer = 1``` (Integer, default 1) Controls the maximum quantity of notifications to be enqueued to the transaction-buffer before delivering them and thus adds the ability to rollback notifications if the transaction fails.
540542
Once this quantity of notifications is reached, then all notifications of the current transaction will immediately be delivered (can be customized per transaction).
541543
Note: There is no way to rollback delivered notifications if current transaction fails later.

pub_sub_model_sync.gemspec

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,11 @@ Gem::Specification.new do |spec|
1111
spec.authors = ['Owen']
1212
spec.email = ['owenperedo@gmail.com']
1313

14-
spec.summary = 'Permit to sync models between apps through pub/sub'
15-
spec.description = 'Permit to sync models between apps through pub/sub'
14+
spec.summary = 'This gem permits to sync automatically models and custom data between multiple Rails
15+
applications by publishing notifications via pubsub (Google PubSub, RabbitMQ, or Apache Kafka) and automatically
16+
processed by all connected applications. Out of the scope, this gem includes transactions to keep Data consistency
17+
by processing notifications in the order they were delivered.'
18+
spec.description = spec.summary
1619
spec.homepage = 'https://github.com/owen2345/pub_sub_model_sync'
1720
spec.license = 'MIT'
1821

0 commit comments

Comments
 (0)