nmspec 1.7.1 → 1.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25522e3d076357896974bf11f009dc4b173cc5007b8a65be45bd8c43b07ac11a
-  data.tar.gz: 2e2b1dd041beefa969cbe11c43a112ad5b94b37ac111790deed80c8e4a77213c
+  metadata.gz: a5b035091a0516537af7cd39096e77932333d53ca448ed1f78c890ca2dfb2077
+  data.tar.gz: b2184d260ec5e1d5ac6ddb7ad006027b79f8e65e08c4b7a7f55e3741ebcc7aa1
 SHA512:
-  metadata.gz: fd89cb542156d4355301124fe9fa2ecdaad9f64317d681ea4840924a95c3f60cf022431dfc79e86147d61ca14469e65ed6306e3d650be266789d248cf5f0e9a9
-  data.tar.gz: fd6fb9409dd17f7361f9d3b9b41ca54b8fd6a21df498a2c9dd375161616103b71ed435736d51b6d39c2cdd2bc70dfe418ab7caf7051cf8fe4d782e0e5fc8452a
+  metadata.gz: 8e9731b8927a877c666630bb8ce61acc3d158e5df7a1a546a4d4ab7f7101cce6145be692336a658c781d46aef1259b80bbc220fdfc5737d36d1a8fde73eef874
+  data.tar.gz: d607d19b6d5a199eba3d318926852fd29e22796171ed995614fea4b8ade42dce3251fcaca11d51f3aa3fb5cedc41842d630e0e2cc8791edb255e5cbf9a3ed82d

data/README.md

@@ -1,9 +1,9 @@
 # `nmspec`
 
 `nmspec` (network message specification) is a combination of binary
-serialization and network communication (two things that are usually treated
-separately), designed to make creating TCP protocols between two ends of a
-network connection easier to specify and keep consistent..
+serialization and network communication (basically [rpc][rpc]), designed to
+make creating TCP protocols between two ends of a network connection easier to
+specify and keep consistent..
 
 A centralized YAML file is used to describe the types and messages passed
 between network peers, and from that description TCP peer code (a "messenger")
@@ -12,12 +12,6 @@ described in `nmspec` are used to create both the reading and writing sides
 of the connection, so that a single source code file contains everything you
 need for a network peer, regardless of if it's the client or server.
 
-## Demo video explaining how to use this gem
-
-<a href="https://youtu.be/Ib6c6BEl82c">
-  <img src="https://s3.us-east-2.amazonaws.com/vim4evar.com/nmspec-imgs/link-to-demo-video.png" />
-</a>
-
 ## Motivation
 
 `nmspec` was specifically created to help with with a problem I was facing,
@@ -51,8 +45,8 @@ purpose.
 
 As a starting point this gem supports network messengers in these two languages:
 
-* [Ruby 3.0.x][ruby-lang]
-* [GDScript 3.4.stable][gdscript]
+* [Ruby 3.x][ruby-lang]
+* [GDScript 3.x.stable][gdscript]
 
 `nmspec` came out of a online game project where the backend is written in
 Ruby, and the frontend is built with the Godot game engine, which includes the
@@ -284,6 +278,9 @@ Output program code is generated in the following manner:
 
 ## Preliminary research, and comparison to other methods
 
+`nmspec` is basically [rpc][rpc], except it also bundles code generators, and
+not just the rpc message/protocol specifications.
+
 I started with researching how other people had designed network protocol
 description languages/tools in the past, beginning with [Prolac][prolac]. This
 lead me to other network messaging tools, binary serialization in general,
@@ -300,6 +297,7 @@ config file, so that a programmer needs only to write a single artifact (a
 `.nmspec` file), and get the code for their target programming language(s)
 generated automatically.
 
+  [rpc]: https://en.wikipedia.org/wiki/Remote_procedure_call
   [ruby-lang]: https://www.ruby-lang.org/
   [gdscript]: https://docs.godotengine.org/en/stable/getting_started/scripting/gdscript/gdscript_basics.html
   [generals.io]: https://generals.io/

data/lib/nmspec/version.rb

@@ -1 +1 @@
-NMSPEC_GEM_VERSION = '1.7.1'
+NMSPEC_GEM_VERSION = '1.7.2'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nmspec
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.7.2
 platform: ruby
 authors:
 - Jeff Lunt