all: add README and update the package documentation

The README briefly describe the module and show some screenshots, similar
with the module documentation.

4 files changed, 89 insertions, 5 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..53f184e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,62 @@
+# Trunks
+
+Module trunks is a library and HTTP service that provide web user interface
+to test HTTP service, similar to Postman, and for load testing.
+
+For the load testing we use vegeta [1] as the backend.
+
+## Usage
+
+See the
+(Example)[https://git.sr.ht/~shulhan/trunks/tree/main/item/example/] package
+on how to programmatically use create service using this module, or,
+
+* clone this repository,
+* execute `make run`, and
+* open http://127.0.0.1:8217.
+
+
+## Screen shots
+
+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)
+
+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)
+
+
+## Web user interface
+
+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,
+
+	<Target.ID> "." <HttpTarget.ID> "." <DateTime> "." <Rate> "x" <Duration> "." <ResultsSuffix>
+
+The "DateTime" is in the following layout,
+
+	YearMonthDate "_" HourMinuteSeconds
+
+The "ResultsSuffix" is the one that defined in Environment.
+
+
+## License
+
+Copyright 2021, Shulhan <ms@kilabit.info>.
+All rights reserved.
+Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.
+
+
+## References
+
+[1] https://github.com/tsenart/vegeta
diff --git a/_screenshots/trunks_attack_result.png b/_screenshots/trunks_attack_result.png
new file mode 100644
index 0000000..5a354b9
--- /dev/null
+++ b/_screenshots/trunks_attack_result.png
diff --git a/_screenshots/trunks_example.png b/_screenshots/trunks_example.png
new file mode 100644
index 0000000..ed8c117
--- /dev/null
+++ b/_screenshots/trunks_example.png
diff --git a/doc.go b/doc.go
index 851b4a9..299cd94 100644
--- a/doc.go
+++ b/doc.go
@@ -8,10 +8,33 @@ to test HTTP service, similar to Postman, and for load testing.
 
 For the load testing we use vegeta [1] as the backend.
 
+Usage
+
+See the example package on how to programmatically use and create service
+using this module, or
+
+	* clone this repository,
+	* execute `make run`, and
+	* open http://127.0.0.1:8217.
+
+
+Screen shots
+
+The following screenshot display the main interface to Run or Attack the
+registered HTTP service,
+
+https://git.sr.ht/~shulhan/trunks/blob/main/_screenshots/trunks_example.png
+
+The following screenshot display the result of attack in two forms, vegeta
+metrics and vegeta histogram,
+
+https://git.sr.ht/~shulhan/trunks/blob/main/_screenshots/trunks_attack_result.png
+
 
 Web user interface
 
-By default, the Trunks user interface can be viewed by opening http://127.0.0.1:8217.
+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.
 
 
@@ -31,10 +54,9 @@ The "ResultsSuffix" is the one that defined in Environment.
 
 License
 
-Copyright 2021, Shulhan <ms@kilabit.info>. All rights reserved.
-
-Use of this source code is governed by a BSD-style
-license that can be found in the LICENSE file.
+Copyright 2021, Shulhan <ms@kilabit.info>.
+All rights reserved.
+Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.
 
 
 References