From d27f1136eb0fbdf7c0aeee6b037bac19ef21b88b Mon Sep 17 00:00:00 2001 From: "Matthew R. Wilson" Date: Mon, 2 Nov 2020 17:46:55 -0800 Subject: [PATCH] Update readme --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6724aaa..f26c406 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ Go 3270 Server Library ====================== +[![PkgGoDev](https://pkg.go.dev/badge/github.com/racingmars/go3270)](https://pkg.go.dev/github.com/racingmars/go3270) + This library allows you to write Go servers for tn3270 clients by building 3270 data streams from fields and processing the client's response to receive the attention keys and field values entered by users. **The library is incomplete, likely buggy, and under heavy development: the interface is UNSTABLE until this notice is removed from this readme and version 1.0 is released.** @@ -12,10 +14,23 @@ Everything I know about 3270 data streams I learned from [Tommy Sprinkle's tutor [rfc1041]: https://tools.ietf.org/html/rfc1041 [rfc854]: https://tools.ietf.org/html/rfc854 +Usage +----- + +See the example folder for a quick demonstration of using the library. + +Future Enhancements +------------------- + +I would like to add: + + - Extended field attribute support (e.g. color). + - Utility functions for easily laying out forms. + Known Problems -------------- - - The telnet data is not checked for the special telnet byte value, 0xFF, which requires escaping while sending and unescaping while receiving data. If your 3270 data streams contain an FF character, things will probably break. + - The telnet data is not checked for the special telnet byte value, 0xFF, which requires escaping while sending and unescaping while receiving data. If your 3270 data streams contain an FF character, things will probably break. However...I don't think 0xFF should ever appear in the datastream, so we're probably okay. - The telnet negotiation does not check for any errors or for any responses from the client. We just assume it goes well and we're actually talking to a tn3270 client. License