sinatra_sockets 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c54288802748884e7b74e50b154fab2d598ea346
-  data.tar.gz: 363af3452bfd9684bd332d6c7988afc2d2b641b5
+  metadata.gz: 15ceae9b0ffb57cf0402226553bbf1d0cead1365
+  data.tar.gz: 1c6991d6bff221887618e35f20946e61b7320161
 SHA512:
-  metadata.gz: 3e5d8b07d6fe155af2297117a9e253631919e92b5aee628d90facbbcaa26c384a8b829e9fea94fd898026b62551da157feda59a9835a4685a5d82d7d760015c2
-  data.tar.gz: 6d59490fd5530989a90e0b031a0deb5069d849c09c4eb3ac819257b83378ba78fef91ff8e7efbb394059341375a572b4697a2769ef33f70074b820e6be59964a
+  metadata.gz: 8d9bfe79ce004845abb884862540554e14ed3713b2c11fb2594ab0600138aa048b6d9500a6726ae40b12ec19652a97c12aa8d2de3df084b2aca4d833c18ca38d
+  data.tar.gz: b5daeb4d873e9f103fbf0fb4f50173adec5e18040a6baf508fac4c86c5577aeb56107f5001ab9fa1f5ea1804924a9fcbd1e17b26e2c2f145859e4377569adcf0

data/README.md

@@ -1,15 +1,39 @@
-This is a gem which is available through rubygems:
+```sh
+$ gem install sinatra_sockets
+$ sinatra_sockets generate .
+```
 
-> gem install sinatra_sockets
+It will print the generated directory tree:
 
-After doing this the `sinatra_sockets generate PATH` shell command can be used.
+```txt
+Generated directory:
+./server_skeleton
+├── config.ru
+├── Gemfile
+├── Gemfile.lock
+├── lib
+│   ├── routes
+│   │   └── ws.rb
+│   └── routes.rb
+├── README.md
+└── server.rb
 
-The generated directory will be called `server_skeleton`. The PATH can be set to `.` for `./server_skeleton` to be created.
+2 directories, 7 files
+```
 
-The generated code is commented and should be read through and customized. 
+Start the server with thin:
 
-In its basic form it's a websocket server using faye-websockets and a very small sinatra front-end with Slim. 
+```sh
+cd server_skeleton
+bundle exec thin start
+# ... listening on localhost:3000
+```
 
-Once generated, `cd server_skeleton` and run `thin start`. Then visit `localhost:3000` and open the dev console.
+Earlier iterations of this had more files, mainly because of front-end stuff. However, I think a boiler is best
+if it's kept minimal, so I removed all that and now it's API only. At the same time, though, I added a token-based
+credential system as well as Github oAuth. Now it can tie in well with a front-end that's hosted on another server like
+Webpack. 
 
-The client will have pinged a message to the server, and the server responds by saying `got <message>`
+This can be seen in action in another boilerplate, [vue-webpack-coffee-slim-boiler](https://github.com/maxpleaner/vue-webpack-coffee-slim-boiler). sinatra_sockets is used as the server component there. 
+
+The source code includes comments. 

data/lib/server_skeleton/Gemfile

@@ -1,5 +1,6 @@
 source "http://rubygems.org"
 
+gem 'byebug'
 gem 'sinatra'
 gem 'faye-websocket'
 gem "thin"

data/lib/version.rb

@@ -1,3 +1,3 @@
 module SinatraSockets
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra_sockets
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - maxpleaner