iosignal 1.8.0 → 2.1.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Taeo Lee <taeo.mocha@gmail.com>
+Copyright (c) 2022 Lee Taeo <taeo.mocha@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -6,33 +6,22 @@ The signaling protocol is built-in, so the server can be used without programmin
 [Kr] iosignal 은 웹브라우저, node.js ,  arduino 간의 실시간 통신을 지원합니다.  또한 보안 인증과 암호통신 기능도 제공됩니다.
 시그널링 프로토콜이 내장되어 있어서 서버는 프로그래밍 없이 사용 가능합니다.
 
-## online demo
-
-### StackBlitz Webcontainer demo
-
-[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/~/github.com/remocons/iosignal-example)
-
-
 ## Install
 
-```
+```shell
 $ npm i iosignal
 ```
 
 ## IOSignal Server
 
-CommonJS and ESM support both
-
-### ESM style
-
-```
+### ESM
+```js
 import { Server } from "iosignal"
 const server = new Server( { port: 7777 } )
 ```
 
-### CJS style
-
-```
+### CJS
+```js
 let { Server } = require('iosignal')
 const server = new Server( { port: 7777 } )
 ```
@@ -48,7 +37,7 @@ const server = new Server(
     port: 7777,     
     congPort: 8888, 
     showMetric: 2,  
-    showMessage: 'message' // show raw signal buffer
+    showMessage: 'message' // show signal message
   })
 
 ```
@@ -59,7 +48,7 @@ const server = new Server(
 - showMessage: "none"|"message" show signal buffer message
 - timeout <milliseconds> ping period & timeout (min. 1000)
 
-### IOSiognal API
+### IOSignal API
 
 IOSignal API examples
 - src/api_reply.js  // 'echo', 'date', 'unixtime'
@@ -72,6 +61,7 @@ To register an API service with the server, use the api() method
 `api('api_name', module )`
 
 ```js
+// node.js
 import { Server ,api_reply  } from 'iosignal'
 const server = new Server( { port: 7777 }  )
 server.api('reply', api_reply) // attach api module
@@ -80,19 +70,21 @@ server.api('reply', api_reply) // attach api module
 Example of a client calling the reply API
 
 ```js
-import { IO } from "iosignal"
-const io = new IO('ws://localhost:7777')
-
-io.on('ready', async ()=>{
-  let res_echo = await io.req('reply', 'echo', 'hello' )
-  let res_date = await io.req('reply', 'date' )
-  let res_unixtime = await io.req('reply', 'unixtime' )
+  // web browser api client example
+  <script src="../dist/iosignal.min.js"></script>
+  <script>
+      const io = new IO('ws://localhost:7777')
 
-  if( res_echo.ok ) console.log( res_echo.body  )
-  if( res_date.ok ) console.log( res_date.body  )
-  if( res_unixtime.ok ) console.log( res_unixtime.body  )
+      io.on('ready', async ()=>{
+        let res_echo = await io.req('reply', 'echo', 'hello' )
+        let res_date = await io.req('reply', 'date' )
+        let res_unixtime = await io.req('reply', 'unixtime' )
 
-});
+        if( res_echo.ok ) console.log( res_echo.body  )
+        if( res_date.ok ) console.log( res_date.body  )
+        if( res_unixtime.ok ) console.log( res_unixtime.body  )
+      });
+  </script>
 
 // result
 [ 'hello' ]
@@ -105,37 +97,36 @@ Fri, 09 Feb 2024 14:24:37 GMT
 ## IOSignal Client
 
 ### NodeJS Client
-```
-// ESM
-import { IO } from "iosignal"
+```js
+  // ESM
+  import { IOWS } from "iosignal"
 
-// CJS
-// const { IO } = require('iosignal')
+  // CJS
+  // const { IOWS } = require('iosignal')
 
-const io = new IO('wss://io.iosignal.net/ws')
+  const io = new IOWS('wss://io.iosignal.net/ws')
 
-io.on('ready', ()=>{
-  console.log('ready cid:', io.cid)
-  io.signal('#screen','playToggle')
-});
+  io.on('ready', ()=>{
+    console.log('ready cid:', io.cid)
+    io.signal('#screen','playToggle')
+  });
 
-io.listen('#notify', (...args)=>{
-  console.log( args )
-})
+  io.listen('#notify', (...args)=>{
+    console.log( args )
+  })
 
-io.on('error',err=>{
-    console.log('err', err)
-})
+  io.on('error',err=>{
+      console.log('err', err)
+  })
 
 ```
 
-### Browser Client : IIFE
-
+### Browser Client : UMD(IIFE)
+- local file: "./dist/iosignal.min.js"
+- CDN: https://cdn.jsdelivr.net/npm/iosignal@2.1.0/dist/iosignal.min.js
 ```html
 <html>
-
-<script src="../dist/iosignal-iife.js"></script>
-
+  <script src="../dist/iosignal.min.js"></script>
   <script>
     console.log('IO', IO)  // default global variable name is IO
 
@@ -185,13 +176,17 @@ io.on('error',err=>{
 ```
 
 ### Browser client : ESM
+
+- local file: "./dist/iosignal.js"
+- CDN: https://cdn.jsdelivr.net/npm/iosignal@2.1.0/dist/iosignal.js
+
 ```html
 <html>
 
   <script type="module">
-    import { IO, Boho, MBP, Buffer  } from "../dist/iosignal.js"
+    import IO from "../dist/iosignal.js"
 
-    const = io = new IO('wss://io.iosignal.net/ws')
+    const io = new IO('wss://io.iosignal.net/ws')
     io.listen('channel#topic', (...args)={
       console.log( args )
     })