From e7e5f54ce3175c6c8ba326c0cc97a13cc9d8fe49 Mon Sep 17 00:00:00 2001 From: Shulhan Date: Mon, 2 Feb 2026 22:21:51 +0700 Subject: README: format with prettier and simplify license text --- README.md | 31 ++++++------------------------- 1 file changed, 6 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index eec05c7..3cc7160 100644 --- a/README.md +++ b/README.md @@ -22,10 +22,9 @@ See the code 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. - +- clone this repository, +- execute `make dev`, and +- open http://127.0.0.1:8217. ## Screenshots @@ -39,14 +38,12 @@ metrics and vegeta histogram, ![Attack result](https://git.sr.ht/~shulhan/gorankusu/blob/main/_screenshots/gorankusu_attack_result.png "Attack result") - ## Web user interface (WUI) By default, the Gorankusu 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 @@ -64,7 +61,6 @@ YearMonthDate "_" HourMinuteSeconds The "ResultsSuffix" is the one that defined in Environment. - ## Development Clone the repository and its submodule, @@ -74,7 +70,7 @@ $ git clone https://git.sr.ht/~shulhan/gorankusu $ git submodule update --init ``` -Install the node tools inside the _www/ sub directory using `yarn`, +Install the node tools inside the \_www/ sub directory using `yarn`, ``` $ cd _www && yarn install @@ -82,7 +78,6 @@ $ cd _www && yarn install Made some changes and finally, run `make` to run lint and test the code. - ## Links [Repository](https://git.sr.ht/~shulhan/gorankusu):: Link to the source code. @@ -96,25 +91,11 @@ feature. [Changelog](https://kilabit.info/project/gorankusu/CHANGELOG.html):: Log for each releases. - ## Credits The Gorankusu icon and image is provided by . - ## License -Copyright (C) 2021 M. Shulhan <ms@kilabit.info> - -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 . +Copyright (C) 2021 M. Shulhan <ms@kilabit.info>. +This software is licensed under GPL version 3.0 or later. -- cgit v1.3