summaryrefslogtreecommitdiffhomepage
path: root/mrbgems/mruby-socket/README.md
diff options
context:
space:
mode:
authorYukihiro "Matz" Matsumoto <[email protected]>2020-12-19 17:31:54 +0900
committerGitHub <[email protected]>2020-12-19 17:31:54 +0900
commit8f06789cb311f31c1ab3fca534a4ab660391db75 (patch)
tree1ef2de0ec2870b6955238ba56b77a434aa772ce6 /mrbgems/mruby-socket/README.md
parentfcc9b7fc2a6d32bd055bbb35396f3af62165a1cb (diff)
parent97eed4493f62da83f81622f5045a5c0db3ef22d2 (diff)
downloadmruby-8f06789cb311f31c1ab3fca534a4ab660391db75.tar.gz
mruby-8f06789cb311f31c1ab3fca534a4ab660391db75.zip
Merge pull request #5232 from jbampton/lint-markdown
feat(CI): add a GitHub Action to lint the Markdown
Diffstat (limited to 'mrbgems/mruby-socket/README.md')
-rw-r--r--mrbgems/mruby-socket/README.md5
1 files changed, 3 insertions, 2 deletions
diff --git a/mrbgems/mruby-socket/README.md b/mrbgems/mruby-socket/README.md
index 947a24e9e..fd20548aa 100644
--- a/mrbgems/mruby-socket/README.md
+++ b/mrbgems/mruby-socket/README.md
@@ -4,8 +4,8 @@ mruby-socket
"mruby-socket" mrbgem provides BSD socket interface for mruby.
API is compatible with CRuby's "socket" library.
-
## Example
+
```sh
% vi kame.rb
s = TCPSocket.open("www.kame.net", 80)
@@ -20,18 +20,19 @@ Date: Tue, 21 May 2013 04:31:30 GMT
```
## Requirement
+
- [mruby-io](https://github.com/mruby/mruby/tree/master/mrbgems/mruby-io) mrbgem
- [iij/mruby-mtest](https://github.com/iij/mruby-mtest) mrgbem to run tests
- system must have RFC3493 basic socket interface
- and some POSIX API...
## TODO
+
- add missing methods
- write more tests
- fix possible descriptor leakage (see XXX comments)
- `UNIXSocket#recv_io` `UNIXSocket#send_io`
-
## License
Copyright (c) 2013 Internet Initiative Japan Inc.