summaryrefslogtreecommitdiffhomepage
path: root/mrbgems/mruby-socket
diff options
context:
space:
mode:
authorJohn Bampton <[email protected]>2020-12-19 18:22:08 +1000
committerJohn Bampton <[email protected]>2020-12-19 18:22:08 +1000
commit97eed4493f62da83f81622f5045a5c0db3ef22d2 (patch)
tree5396c8a3a3a76341119d3f86c8e69d4b624f6337 /mrbgems/mruby-socket
parent340f1f0094b41c30dc2377cca4a18a6466828091 (diff)
downloadmruby-97eed4493f62da83f81622f5045a5c0db3ef22d2.tar.gz
mruby-97eed4493f62da83f81622f5045a5c0db3ef22d2.zip
feat(CI): add a GitHub Action to lint the Markdown
Run on pull request only Using https://www.npmjs.com/package/markdownlint-cli Lint Markdown for rules: - MD009/no-trailing-spaces - MD012/no-multiple-blanks - MD022/blanks-around-headings - MD031/blanks-around-fences - MD032/blanks-around-lists
Diffstat (limited to 'mrbgems/mruby-socket')
-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.