Browse Source

Update documentation.

Roberto Ostinelli 3 years ago
parent
commit
099164f49c
2 changed files with 12 additions and 12 deletions
  1. 3 3
      OPTIONS.md
  2. 9 9
      README.md

+ 3 - 3
OPTIONS.md

@@ -60,8 +60,8 @@ At almost the same time another process might also request to update process A's
 its metadata to `[{color, "blue"}, {weight, 1.0}]`.
 its metadata to `[{color, "blue"}, {weight, 1.0}]`.
 
 
 These requests will be delivered to the authority node which will treat them sequentially.
 These requests will be delivered to the authority node which will treat them sequentially.
-Therefore, the first incoming request (for eg. the one to set size) will be overwritten shortly after
-by the second incoming request (to set the weight), thus resulting in the loss of the `{size, 100}` tuple
+Therefore, the first incoming request (for eg. the one that sets the size) will be overwritten shortly after
+by the second incoming request (the one that sets the weight), thus resulting in the loss of the `{size, 100}` tuple
 in the process' metadata.  The end result will be that process A' metadata will be propagated to the whole cluster as
 in the process' metadata.  The end result will be that process A' metadata will be propagated to the whole cluster as
 `[{color, "blue"}, {weight, 1.0}]`.
 `[{color, "blue"}, {weight, 1.0}]`.
 
 
@@ -98,7 +98,7 @@ With `strict_mode` turned on:
 ok
 ok
 ```
 ```
 
 
-`strict_mode` can be turned on by setting the `strict_mode` configuration variable.
+Strict mode can be turned on by setting the `strict_mode` configuration variable.
 
 
 #### Elixir
 #### Elixir
 ```elixir
 ```elixir

+ 9 - 9
README.md

@@ -6,15 +6,15 @@ able to automatically manage dynamic clusters (addition / removal of nodes) and
 
 
 Syn is a replacement for Erlang/OTP
 Syn is a replacement for Erlang/OTP
 [global](https://www.erlang.org/doc/man/global.html)'s registry and
 [global](https://www.erlang.org/doc/man/global.html)'s registry and
-[pg](https://www.erlang.org/doc/man/pg.html). The main differences with these OTP's implementations are:
-
- *  `global`: OTP's global module choses Consistency over Availability, therefore it can become difficult to scale
-    when registration rates are elevated and the cluster becomes larger. If eventual consistency is acceptable in your
-    case, Syn can considerably increase the registry's performance. Additionally, Syn allows to attach metadata to every
-    registered process, which also gets synchronized across the cluster.
- *  `pg`: OTP's pg module, like Syn, implements Strong Eventual Consistency. However, Syn also allows to attach metadata
-    information to processes, and implements [cluster-wide callbacks](syn_event_handler.html) on the main events. 
- 
+[pg](https://www.erlang.org/doc/man/pg.html) modules. The main differences with these OTP's implementations are:
+
+* OTP's `global` module chooses Consistency over Availability, therefore it can become difficult to scale
+  when registration rates are elevated and the cluster becomes larger. If eventual consistency is acceptable in your
+  case, Syn can considerably increase the registry's performance.
+* Syn allows to attach metadata to every process, which also gets synchronized across the cluster.
+* Syn implements [cluster-wide callbacks](syn_event_handler.html) on the main events, which are also properly triggered
+  after net splits.
+
 [[Documentation](https://hexdocs.pm/syn/)]
 [[Documentation](https://hexdocs.pm/syn/)]
 
 
 ## Introduction
 ## Introduction