From 15553baba4712cce1310686951f31e73885aaba2 Mon Sep 17 00:00:00 2001 From: Shulhan Date: Tue, 16 May 2023 14:23:01 +0700 Subject: all: convert the README from asciidoc to markdown I use two remote repositories: GitHub and SourceHut. GitHub support rendering README using asciidoc while SourceHut not. This cause the repository that use README.adoc rendered as text in SourceHut which make the repository page less readable. Also, the pkg.go.dev now render README but only support Markdown. Since we cannot control the SourceHut and go.dev, the only option is to support converting Markdown in ciigo so I can write README using Markdown and the rest of documentation using Asciidoc. --- README | 97 --------------------------------- README.adoc | 1 - README.md | 98 ++++++++++++++++++++++++++++++++++ _doc/README.adoc | 1 - _doc/README.md | 1 + _screenshots/trunks_attack_result.png | Bin 252107 -> 85257 bytes _screenshots/trunks_example.png | Bin 154326 -> 52315 bytes 7 files changed, 99 insertions(+), 99 deletions(-) delete mode 100644 README delete mode 120000 README.adoc create mode 100644 README.md delete mode 120000 _doc/README.adoc create mode 120000 _doc/README.md diff --git a/README b/README deleted file mode 100644 index ce75a13..0000000 --- a/README +++ /dev/null @@ -1,97 +0,0 @@ -= Trunks -:toc: -:sectanchors: -:sectlinks: - -Trunks is a Go library that provide HTTP service with web user interface -to test HTTP and/or WebSocket endpoints and for load testing HTTP endpoints. - -For testing HTTP endpoints it use the -https://pkg.go.dev/github.com/shuLhan/share/lib/http[lib/http^] -package as the client, a wrapper for standard Go HTTP package. -For testing WebSocket endpoints it use the -https://pkg.go.dev/github.com/shuLhan/share/lib/websocket[lib/websocket^] -package as the client. -For the load testing we use -https://github.com/tsenart/vegeta[vegeta^] -as the backend. - -https://pkg.go.dev/git.sr.ht/~shulhan/trunks[Go doc^]. - -== Usage - -See the -https://git.sr.ht/~shulhan/trunks/tree/main/item/example/[example^] -package on how to programmatically use and create service using this module, -or, - -* clone this repository, -* execute `make dev`, and -* open http://127.0.0.1:8217. - - -== Screenshots - -The following screenshot display the main interface to Run or Attack the -registered HTTP service, - -image:https://git.sr.ht/~shulhan/trunks/blob/main/_screenshots/trunks_example.png[Main interface,640] - -The following screenshot display the result of attack in two forms, vegeta -metrics and vegeta histogram, - -image:https://git.sr.ht/~shulhan/trunks/blob/main/_screenshots/trunks_attack_result.png[Attack result,640] - - -== Web user interface (WUI) - -By default, the Trunks user interface can be viewed by opening in browser at -http://127.0.0.1:8217. -One can change address through Environment's ListenAddress. - - -== File name format - -Each attack result is saved in Environment's ResultsDir with the following -file name format, - - "." "." "." "x" "." - -The "DateTime" is in the following layout, - - YearMonthDate "_" HourMinuteSeconds - -The "ResultsSuffix" is the one that defined in Environment. - - -== Development - -https://git.sr.ht/~shulhan/trunks[Repository^]:: Link to the source code. - -https://lists.sr.ht/~shulhan/trunks[Mailing list^]:: Link to discussion and -where to send patches. - -https://todo.sr.ht/~shulhan/trunks[Issues^]:: Link to report for bug or -feature. - - -== Credits - -The Trunks icon and image is provided by https://www.spriters-resource.com/. - -== License - -Copyright (C) 2021 M. Shulhan - -This program is free software: you can redistribute it and/or modify it under -the terms of the GNU General Public License as published by the Free Software -Foundation, either version 3 of the License, or (at your option) any later -version. - -This program is distributed in the hope that it will be useful, but WITHOUT -ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS -FOR A PARTICULAR PURPOSE. See the GNU General Public License for more -details. - -You should have received a copy of the GNU General Public License along with -this program. If not, see . diff --git a/README.adoc b/README.adoc deleted file mode 120000 index 100b938..0000000 --- a/README.adoc +++ /dev/null @@ -1 +0,0 @@ -README \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..d7a5e07 --- /dev/null +++ b/README.md @@ -0,0 +1,98 @@ +# Trunks + +Trunks is a Go library that provide HTTP service with web user interface +to test HTTP and/or WebSocket endpoints and for load testing HTTP endpoints. + +For testing HTTP endpoints it use the +[lib/http](https://pkg.go.dev/github.com/shuLhan/share/lib/http) +package as the client, a wrapper for standard Go HTTP package. +For testing WebSocket endpoints it use the +[lib/websocket](https://pkg.go.dev/github.com/shuLhan/share/lib/websocket) +package as the client. +For the load testing we use +[vegeta](https://github.com/tsenart/vegeta) +as the backend. + +[Go documentation](https://pkg.go.dev/git.sr.ht/~shulhan/trunks) + +## Usage + +See the +[example](https://git.sr.ht/~shulhan/trunks/tree/main/item/example/) +package on how to programmatically use and create service using this module, +or, + +* clone this repository, +* execute `make dev`, and +* open . + + +## Screenshots + +The following screenshot display the main interface to Run or Attack the +registered HTTP service, + +![Main interface](https://git.sr.ht/~shulhan/trunks/blob/main/_screenshots/trunks_example.png "Main interface") + +The following screenshot display the result of attack in two forms, vegeta +metrics and vegeta histogram, + +![Attack result](https://git.sr.ht/~shulhan/trunks/blob/main/_screenshots/trunks_attack_result.png "Attack result") + + +## Web user interface (WUI) + +By default, the Trunks user interface can be viewed by opening in browser at +. +One can change address through Environment's ListenAddress. + + +## File name format + +Each attack result is saved in Environment's ResultsDir with the following +file name format, + +``` + "." "." "." "x" "." +``` + +The "DateTime" is in the following layout, + +``` +YearMonthDate "_" HourMinuteSeconds +``` + +The "ResultsSuffix" is the one that defined in Environment. + + +## Development + +[Repository](https://git.sr.ht/~shulhan/trunks):: Link to the source code. + +[Mailing list](https://lists.sr.ht/~shulhan/trunks):: Link to discussion and +where to send patches. + +[Issues](https://todo.sr.ht/~shulhan/trunks):: Link to report for bug or +feature. + + +## Credits + +The Trunks icon and image is provided by . + +## License + +Copyright (C) 2021 M. Shulhan + +This program is free software: you can redistribute it and/or modify it under +the terms of the GNU General Public License as published by the Free Software +Foundation, either version 3 of the License, or (at your option) any later +version. + +This program is distributed in the hope that it will be useful, but WITHOUT +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +FOR A PARTICULAR PURPOSE. See the GNU General Public License for more +details. + +You should have received a copy of the GNU General Public License along with +this program. If not, see . diff --git a/_doc/README.adoc b/_doc/README.adoc deleted file mode 120000 index a7ab0b1..0000000 --- a/_doc/README.adoc +++ /dev/null @@ -1 +0,0 @@ -../README.adoc \ No newline at end of file diff --git a/_doc/README.md b/_doc/README.md new file mode 120000 index 0000000..32d46ee --- /dev/null +++ b/_doc/README.md @@ -0,0 +1 @@ +../README.md \ No newline at end of file diff --git a/_screenshots/trunks_attack_result.png b/_screenshots/trunks_attack_result.png index d463af6..8f64a96 100644 Binary files a/_screenshots/trunks_attack_result.png and b/_screenshots/trunks_attack_result.png differ diff --git a/_screenshots/trunks_example.png b/_screenshots/trunks_example.png index 3b7f660..705e040 100644 Binary files a/_screenshots/trunks_example.png and b/_screenshots/trunks_example.png differ -- cgit v1.3