README.md in boom_nats-0.1.1 vs README.md in boom_nats-0.1.2
- old
+ new
@@ -3,18 +3,22 @@
NATS is a simple, secure and performant communications system for digital systems, services and devices. NATS is part of the Cloud Native Computing Foundation (CNCF). See more on [Github NATS](https://github.com/nats-io/nats-server).
This implementation works in both modes: Standalone and Rails based applications.
## Documentation
-- [Configurations](#configurations)
-- [Rails](#rails)
- - [Installing](#rails-installing)
- - [Configuration](#rails-configuration)
-- [Standalone](#standalone)
- - [Installing](#standalone-installing)
- - [Configuration](#standalone-configuration)
- - [Starting Application](#standalone-starting-application)
+
+- [BoomNats](#boomnats)
+ - [Documentation](#documentation)
+ - [configurations](#configurations)
+ - [Rails](#rails)
+ - [Rails Installing](#rails-installing)
+ - [Rails Configuration](#rails-configuration)
+ - [Standalone](#standalone)
+ - [Standalone Installing](#standalone-installing)
+ - [Standalone Configuration](#standalone-configuration)
+ - [Standalone Starting Application](#standalone-starting-application)
+
## configurations
```ruby
require 'boom_nats'
# require_relative "consumers/...."
@@ -26,12 +30,12 @@
# Clustering NATS
servers ["nats://nats1:4222", "nats://nats2:4222"]
# with authentication
servers "nats://user:pass@localhost:4222"
-
+
# map NATS topics to Topic classes
draw_routes do
topic "topic-name", MyTopic
topic "namespace.topic", NamespacedTopic
topic "topic-queued", QueuedTopic, queue: 'queue-name'
@@ -84,11 +88,10 @@
```bash
rails g boom_nats:consumer PaymentGetter
# creates file: app/consumers/payment_getter_consumer.rb
```
-
## Standalone
To facilitate learning, you can download the default repository containing a boilerplate project with (Ruby, Nats and ActiveRecord)
```bash
@@ -106,10 +109,10 @@
```
With bundle, add gem to Gemfile
```ruby
-gem 'boom_nats', '~> 0.1.0'
+gem 'boom_nats', '~> 0.1.2'
```
### Standalone Configuration
Create a simple file `boom_nats.rb` and put this content: