diff options
| author | Shulhan <ms@kilabit.info> | 2026-01-13 21:06:41 +0700 |
|---|---|---|
| committer | Shulhan <ms@kilabit.info> | 2026-01-13 21:06:41 +0700 |
| commit | d18ec5d8635bf3dc02b23acdbf861ce518e54058 (patch) | |
| tree | c88b021406ebfcceba2f38aff7c1d85b2b2ec402 | |
| parent | 06eb22e30f855d70468640ea72e23c43e384c793 (diff) | |
| download | pakakeh.go-d18ec5d8635bf3dc02b23acdbf861ce518e54058.tar.xz | |
README: format the file using prettier
| -rw-r--r-- | README.md | 78 |
1 files changed, 24 insertions, 54 deletions
@@ -1,7 +1,6 @@ <!-- -SPDX-FileCopyrightText: 2018 M. Shulhan <ms@kilabit.info> - SPDX-License-Identifier: BSD-3-Clause +SPDX-FileCopyrightText: 2018 M. Shulhan <ms@kilabit.info> --> # `import "git.sr.ht/~shulhan/pakakeh.go"` @@ -23,7 +22,6 @@ only standard packages. Package bot implement the [Telegram Bot API](https://core.telegram.org/bots/api). - ## Command Line Interface [**ansua**](https://pkg.go.dev/git.sr.ht/~shulhan/pakakeh.go/cmd/ansua):: @@ -43,7 +41,7 @@ nanoseconds, local time, and UTC time) or the date and time based on the epoch on first parameter. [**gofmtcomment**](https://pkg.go.dev/git.sr.ht/~shulhan/pakakeh.go/cmd/gofmtcomment):: -Program to convert multi lines "/**/" comments into single line "//" format. +Program to convert multi lines "/\*\*/" comments into single line "//" format. [**httpdfs**](https://pkg.go.dev/git.sr.ht/~shulhan/pakakeh.go/cmd/httpdfs):: Program httpdfs implement [libhttp.Server] with [memfs.MemFS]. @@ -74,7 +72,6 @@ Program xtrk is command line interface to uncompress and/or unarchive a file. Supported format: bzip2, gzip, tar, zip, tar.bz2, tar.gz. - ## Libraries [**ascii**](https://pkg.go.dev/git.sr.ht/~shulhan/pakakeh.go/lib/ascii):: @@ -92,7 +89,6 @@ A library for working with slice of bytes. [**clise**](https://pkg.go.dev/git.sr.ht/~shulhan/pakakeh.go/lib/clise):: Package clise implements circular slice. - [**contact**](https://pkg.go.dev/git.sr.ht/~shulhan/pakakeh.go/lib/contact):: A library to import contact from Google, Microsoft, or Yahoo. @@ -109,7 +105,6 @@ formatted data. [**contact/yahoo**](https://pkg.go.dev/git.sr.ht/~shulhan/pakakeh.go/lib/contact/yahoo):: Package yahoo implement user's contacts import using Yahoo API. - [**crypto**](https://pkg.go.dev/git.sr.ht/~shulhan/pakakeh.go/lib/crypto):: Package crypto provide a wrapper to simplify working with standard crypto package. @@ -124,7 +119,6 @@ A library for working with Domain Name System (DNS) protocol. [**dsv**](https://pkg.go.dev/git.sr.ht/~shulhan/pakakeh.go/lib/dsv):: A library for working with delimited separated value (DSV). - [**email**](https://pkg.go.dev/git.sr.ht/~shulhan/pakakeh.go/lib/email):: A library for working with Internet Message Format, as defined in RFC 5322. @@ -135,7 +129,6 @@ defined in RFC 6376. [**email/maildir**](https://pkg.go.dev/git.sr.ht/~shulhan/pakakeh.go/lib/email/maildir):: A library to manage email using maildir format. - [**errors**](https://pkg.go.dev/git.sr.ht/~shulhan/pakakeh.go/lib/errors):: Package errors provide an error type with Code, Message, and Name. @@ -151,7 +144,6 @@ It support parsing output from hexdump(1) tool. Package html extends the golang.org/x/net/html by providing simplified methods for working with Node. - [**http**](https://pkg.go.dev/git.sr.ht/~shulhan/pakakeh.go/lib/http):: Package http extends the standard http package with simplified routing handler and builtin memory file system. @@ -159,7 +151,6 @@ and builtin memory file system. [**http/sseclient**](https://pkg.go.dev/git.sr.ht/~shulhan/pakakeh.go/lib/http/sseclient):: Package sseclient implement HTTP client for Server-Sent Events (SSE). - [**ini**](https://pkg.go.dev/git.sr.ht/~shulhan/pakakeh.go/lib/ini):: A library for reading and writing INI configuration as defined by Git configuration file syntax. @@ -167,7 +158,6 @@ configuration file syntax. [**json**](https://pkg.go.dev/git.sr.ht/~shulhan/pakakeh.go/lib/json):: Package json extends the capabilities of standard json package. - [**math**](https://pkg.go.dev/git.sr.ht/~shulhan/pakakeh.go/lib/math):: Package math provide generic functions working with math. @@ -176,12 +166,10 @@ Package big extends the capabilities of standard "math/big" package by adding custom global precision to Float, Int, and Rat, global rounding mode, and custom bits precision to Float. - [**memfs**](https://pkg.go.dev/git.sr.ht/~shulhan/pakakeh.go/lib/memfs):: A library for mapping file system into memory and to generate an embedded Go file from it. - [**mining**](https://pkg.go.dev/git.sr.ht/~shulhan/pakakeh.go/lib/mining):: A library for data mining. @@ -213,7 +201,6 @@ An implementation of the Synthetic Minority Oversampling TEchnique (SMOTE). [**mining/tree/binary**](https://pkg.go.dev/git.sr.ht/~shulhan/pakakeh.go/lib/mining/tree/binary):: An implementation of binary tree. - [**mlog**](https://pkg.go.dev/git.sr.ht/~shulhan/pakakeh.go/lib/mlog):: Package mlog implement buffered multi writers of log. @@ -224,7 +211,6 @@ Constants and library for networking. A library for working with integer, float, slice of integer, and slice of floats. - [**os**](https://pkg.go.dev/git.sr.ht/~shulhan/pakakeh.go/lib/os):: Package os extend the standard os package to provide additional functionalities. @@ -233,7 +219,6 @@ functionalities. Package exec wrap the standar package "os/exec" to simplify calling Run with stdout and stderr. - [**paseto**](https://pkg.go.dev/git.sr.ht/~shulhan/pakakeh.go/lib/paseto):: A simple, ready to use, implementation of Platform-Agnostic SEcurity TOkens (PASETO). @@ -290,7 +275,6 @@ Package telemetry is a library for collecting various [Metric], for example from standard runtime/metrics, and send or write it to one or more [Forwarder]. - [**test**](https://pkg.go.dev/git.sr.ht/~shulhan/pakakeh.go/lib/test):: A library for helping with testing. @@ -300,21 +284,17 @@ Package httptest implement testing HTTP package. [**test/mock**](https://pkg.go.dev/git.sr.ht/~shulhan/pakakeh.go/lib/test/mock):: Package mock provide a mocking for standard output and standard error. - [**text**](https://pkg.go.dev/git.sr.ht/~shulhan/pakakeh.go/lib/text):: A library for working with text. [**text/diff**](https://pkg.go.dev/git.sr.ht/~shulhan/pakakeh.go/lib/text/diff):: Package diff implement text comparison. - [**time**](https://pkg.go.dev/git.sr.ht/~shulhan/pakakeh.go/lib/time):: A library for working with time. [**totp**](https://pkg.go.dev/git.sr.ht/~shulhan/pakakeh.go/lib/totp):: -Package totp implement Time-Based One-Time Password Algorithm based on RFC -6238. - +Package totp implement Time-Based One-Time Password Algorithm based on RFC 6238. [**watchfs**](https://pkg.go.dev/git.sr.ht/~shulhan/pakakeh.go/lib/watchfs):: Package watchfs implement naive file and directory watcher. @@ -326,7 +306,6 @@ Package watchfs implement naive file watcher. The version 2 simplify watching single file and directory. For directory watcher, it watch only one file instead of all included files. - [**websocket**](https://pkg.go.dev/git.sr.ht/~shulhan/pakakeh.go/lib/websocket):: The WebSocket library for server and client. This WebSocket library has been tested with autobahn testsuite with 100% success rate. @@ -336,52 +315,45 @@ been tested with autobahn testsuite with 100% success rate. Package xmlrpc provide an implementation of [XML-RPC specification](http://xmlrpc.com/spec.md). - ## Simplified RFCs ### MIME -* [RFC 2045: MIME Part One - Format of Internet Message Bodies](RFC_2045__MIME_I_FORMAT.html). -* [RFC 2046: MIME Part Two - Media Types](RFC_2046__MIME_II_MEDIA_TYPES.html). -* [RFC 2049: MIME Part Five: Conformance Criteria and Examples](RFC_2049__MIME_V_CONFORMANCE.html). -* [RFC 5322: Internet Message Format](RFC_5322__IMF.html). - +- [RFC 2045: MIME Part One - Format of Internet Message Bodies](RFC_2045__MIME_I_FORMAT.html). +- [RFC 2046: MIME Part Two - Media Types](RFC_2046__MIME_II_MEDIA_TYPES.html). +- [RFC 2049: MIME Part Five: Conformance Criteria and Examples](RFC_2049__MIME_V_CONFORMANCE.html). +- [RFC 5322: Internet Message Format](RFC_5322__IMF.html). ### SASL -* [RFC 4422: Simple Authentication and Security Layer](RFC_4422__SASL.html). -* [RFC 4616: The PLAIN Simple Authentication and Security Layer (SASL) Mechanism](RFC_4616__SASL_PLAIN.html). - +- [RFC 4422: Simple Authentication and Security Layer](RFC_4422__SASL.html). +- [RFC 4616: The PLAIN Simple Authentication and Security Layer (SASL) Mechanism](RFC_4616__SASL_PLAIN.html). ### DKIM -* [RFC 4685: Analysis of Threats Motivating DKIM](RFC_4865__DKIM_THREATS.html). -* [RFC 5585: DomainKeys Identified Mail Service Overview](RFC_5585__DKIM_OVERVIEW.html). -* [RFC 5863: DKIM Development, Deployment, and Operations](RFC_5863__DKIM_DEVOPS.html). -* [RFC 6376: DKIM Signatures](RFC_6376__DKIM_SIGNATURES.html). - +- [RFC 4685: Analysis of Threats Motivating DKIM](RFC_4865__DKIM_THREATS.html). +- [RFC 5585: DomainKeys Identified Mail Service Overview](RFC_5585__DKIM_OVERVIEW.html). +- [RFC 5863: DKIM Development, Deployment, and Operations](RFC_5863__DKIM_DEVOPS.html). +- [RFC 6376: DKIM Signatures](RFC_6376__DKIM_SIGNATURES.html). ### SMTP -* [RFC 3207: SMTP Service Extension for Secure SMTP over Transport Layer Security](RFC_3207__ESMTP_TLS.html). -* [RFC 3461-3464: Delivery Status Notification](RFC_3461-3464__ESMTP_DSN.html). -* [RFC 4954: SMTP Service Extension for Authentication](RFC_4954__ESMTP_AUTH.html). -* [RFC 5321: Simple Mail Transfer Protocol](RFC_5321__SMTP.html). - +- [RFC 3207: SMTP Service Extension for Secure SMTP over Transport Layer Security](RFC_3207__ESMTP_TLS.html). +- [RFC 3461-3464: Delivery Status Notification](RFC_3461-3464__ESMTP_DSN.html). +- [RFC 4954: SMTP Service Extension for Authentication](RFC_4954__ESMTP_AUTH.html). +- [RFC 5321: Simple Mail Transfer Protocol](RFC_5321__SMTP.html). ### SPF -* [RFC 7208: Sender Policy Framework version 1](RFC_7808__SPFv1.html). - +- [RFC 7208: Sender Policy Framework version 1](RFC_7808__SPFv1.html). ## DNS -* [RFC 6891: Extension Mechanisms for DNS (EDNS(0)](RFC_6891_EDNS0.html). +- [RFC 6891: Extension Mechanisms for DNS (EDNS(0)](RFC_6891_EDNS0.html). -* [RFC 9460: Service Binding and Parameter Specification via the DNS +- [RFC 9460: Service Binding and Parameter Specification via the DNS (SVCB and HTTPS Resource Records)](RFC_9460__SVCB_and_HTTP_RR.html). - ## Changelog This library is released every month, usually at the first week of month. @@ -406,14 +378,12 @@ Changelog for `pakakeh.go` module since v0.12.0 until v0.21.0. [Changelog from 2018 to 2019](CHANGELOG_2018-2019.html). Changelog for `pakakeh.go` v0.1.0 until v0.11.0. - ## Credits [Autobahn testsuite](https://github.com/crossbario/autobahn-testsuite) for testing WebSocket library. - -## Development +## Development <https://git.sr.ht/~shulhan/pakakeh.go>:: Link to the source code. @@ -424,7 +394,6 @@ List of open issues. <https://lists.sr.ht/~shulhan/pakakeh.go>:: Link to submit the patches. - ## License Copyright (c) 2018 M. Shulhan <ms@kilabit.info> @@ -441,7 +410,7 @@ modification, are permitted provided that the following conditions are met: 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this - software without specific prior written permission. + software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE @@ -455,5 +424,6 @@ ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ----- +--- + That's it! Happy hacking! |
