Skip to content

Commit

Permalink
Clarify intended usage
Browse files Browse the repository at this point in the history
  • Loading branch information
edwardalee committed Feb 11, 2024
1 parent ea183b5 commit b952841
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion examples/C/src/lib/WebSocketServer.lf
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
/**
* A web socket server enabling a user interface realized in the browser. This creates a web server
* that listens on a port (default 8000) for web socket connections.
* that listens on a port (default 8000) for web socket connections. The intended usage is that you
* create a client in an HTML/JavaScript file that connects to this server and provides a browser-based
* user interface.
*
* When a connection is established with a client, an output is produced on the connected port that
* is a struct with a unique wsi (web socket interface) for the client and a boolean indicating
Expand Down

0 comments on commit b952841

Please sign in to comment.