Skip to content

Commit a0de3fb

Browse files
committed
update readme documentation and screenshots
1 parent 04df7bd commit a0de3fb

14 files changed

+81
-64
lines changed

README.md

Lines changed: 81 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,107 +1,124 @@
11
# dev-tools ![Build](https://github.com/reugn/dev-tools/workflows/Build/badge.svg)
22

3-
Widely used software developer tools in a single application.
4-
* [Json Editor](#json_editor)
5-
* [UUID/Password Generator](#generator)
6-
* [Hash Calculator](#hash_calculator)
7-
* [Epoch Converter](#epoch_converter)
8-
* [Regular Expression Tester](#regex)
9-
* [Rest API Tester](#rest_api)
10-
* [ASCII Graphics](#ascii)
11-
* [Logs Generator](#logs)
3+
A collection of developer utilities in a single desktop application.
4+
5+
* [JSON Editor](#json-editor)
6+
* [Image Editor](#image-editor)
7+
* [Rest API Tester](#rest-api-tester)
8+
* [JWT Decoder](#jwt-decoder)
9+
* [UUID/Password Generator](#uuid-password-generator)
10+
* [Hash Calculator](#hash-calculator)
11+
* [Epoch Converter](#epoch-converter)
12+
* [Regular Expression Tester](#regular-expression-tester)
13+
* [ASCII Graphics](#ascii-graphics)
14+
* [Log Generator](#log-generator)
1215

1316
## Installation
14-
* `dev-tools` is a [JavaFX](https://openjfx.io/) Maven application.
15-
Build an executable jar from the source.
17+
18+
`dev-tools` is a [JavaFX](https://openjfx.io/) desktop application built with Maven.
19+
Obtain a binary using one of the following methods:
20+
21+
* Build an executable jar from the source.
22+
1623
```
17-
mvn clean package -U
24+
./mvnw clean package
1825
```
1926

20-
* Build a native application using the [GluonFX Maven plugin](https://github.com/gluonhq/gluonfx-maven-plugin).
21-
[GraalVM](https://www.graalvm.org/) installation is required.
27+
* Build a native application using [GluonFX Maven plugin](https://github.com/gluonhq/gluonfx-maven-plugin).
28+
[GraalVM](https://www.graalvm.org/) installation is required. After obtaining the GraalVM distribution, the
29+
environment variable `GRAALVM_HOME` should be set to point to it.
30+
2231
```
23-
mvn clean gluonfx:build
32+
./mvnw clean gluonfx:build
2433
```
2534

26-
* Download a build from the [releases](https://github.com/reugn/dev-tools/releases).
35+
* Download a build from [releases](https://github.com/reugn/dev-tools/releases).
2736

2837
## Prerequisites
29-
* Java 11 (JavaFX is not a part of Java SDK as of JDK 11).
3038

31-
## Features
32-
* Dark/Light mode.
39+
* Java 11 or later
3340

34-
## Tools List
41+
## Getting Started
3542

36-
<a name="json_editor"/>
43+
* Launch the application. For the executable jar use `java -jar target/dev-tools-<version>.jar`.
44+
* Explore the main menu and its options.
45+
* Select a tool from the `Tools` dropdown menu. See below for a complete list with screenshots.
46+
* Switch between light and dark themes using the `View -> Theme` menu option.
47+
* Utilize keyboard shortcuts for faster navigation.
3748

38-
### Json Editor
39-
* JSON pretty print with highlighting.
40-
* JSON validation.
41-
* Search Bar (Ctrl+F).
49+
## Tool List
50+
51+
### JSON Editor
52+
53+
Edit and analyze JSON using syntax highlighting, formatting, and validation.
54+
Use the built-in search (Ctrl+F) to find items. Navigate between documents using the multi-tab interface.
4255

4356
![](docs/images/json_editor.png)
4457

45-
<a name="generator"/>
58+
### Image Editor
4659

47-
### UUID/Password Generator
48-
* UUID Generator.
49-
* Password Generator.
60+
This tool incorporates an essential suite of functions for creating and editing images.
5061

51-
![](docs/images/generator.png)
62+
![](docs/images/image_editor.png)
5263

53-
<a name="hash_calculator"/>
64+
### Rest API Tester
5465

55-
### Hash Calculator
56-
* Hash functions.
57-
* URL Encode/Decode.
58-
* Base64 Encode/Decode.
66+
This tool provides a core set of functionalities for REST API testing.
67+
Manage and share your testing process via the export and import of HTTP request history.
68+
Access history features by Ctrl-clicking the history pane. Navigate between requests using the multi-tab interface.
5969

60-
![](docs/images/hash_calculator.png)
70+
![](docs/images/rest_api.png)
6171

62-
<a name="epoch_converter"/>
72+
### JWT Decoder
6373

64-
### Epoch Converter
65-
* Current Unix epoch time.
66-
* Timestamp to human date.
67-
* Human date to timestamp.
74+
Paste your JSON Web Token (JWT) into the input area to decode it. Use the provided buttons to
75+
decode, encode, and verify the JWT signature. For signature verification, select the correct algorithm and provide
76+
the necessary secrets.
6877

69-
![](docs/images/epoch_converter.png)
78+
![](docs/images/jwt_decoder.png)
7079

71-
<a name="regex"/>
80+
### UUID-Password Generator
7281

73-
### Regular Expression Tester
74-
* Regex flags.
75-
* Capturing groups.
82+
Generate a series of UUIDs (Universally Unique Identifiers) or passwords according to the provided configuration
83+
controls.
7684

77-
![](docs/images/regex.png)
85+
![](docs/images/generator.png)
7886

79-
<a name="rest_api"/>
87+
### Hash Calculator
8088

81-
### Rest API Tester
82-
* Rest API testing client.
83-
* Export/import HTTP request history.
89+
This utility performs cryptographic hashing and various encoding/decoding operations on input data.
8490

85-
![](docs/images/rest_api.png)
91+
![](docs/images/hash_calculator.png)
92+
93+
### Epoch Converter
8694

87-
<a name="ascii"/>
95+
Epoch Converter is a utility for converting between Unix epoch time (seconds since January 1, 1970, 00:00:00 UTC)
96+
and human-readable dates. Features include displaying the current Unix epoch, timestamp to date/time
97+
conversion, and date/time to timestamp conversion.
98+
99+
![](docs/images/epoch_converter.png)
100+
101+
### Regular Expression Tester
102+
103+
Regular Expression Tester is a tool for testing and debugging regular expressions (regex) featuring full regex flag
104+
support (i, m, u, etc.), comprehensive capturing group visualization and match highlighting.
105+
106+
![](docs/images/regex_tester.png)
88107

89108
### ASCII Graphics
90-
* Convert text to ASCII art.
91109

92-
![](docs/images/ascii.png)
110+
Easily turn your text into ASCII art. Customize the look with adjustable settings.
93111

94-
<a name="logs"/>
112+
![](docs/images/ascii_graphics.png)
95113

96-
### Logs Generator
97-
* Generate fake log workloads using a specified format.
98-
* Write to console.
99-
* Write to file.
114+
### Log Generator
100115

101-
![](docs/images/logs.png)
116+
Log Generator creates customizable synthetic log data for testing and development.
117+
Choose from a selection of pre-defined standard log formats.
118+
Write the generated logs directly to the output pane, or save them to a file for later use.
102119

103-
## Contributing
104-
If you find this project useful and want to contribute, please open an issue or create a PR.
120+
![](docs/images/log_generator.png)
105121

106122
## License
107-
Licensed under the Apache 2.0 License.
123+
124+
Licensed under the Apache 2.0 license.

docs/images/ascii.png

-446 KB
Binary file not shown.

docs/images/ascii_graphics.png

401 KB
Loading

docs/images/epoch_converter.png

-29.3 KB
Loading

docs/images/generator.png

3.31 KB
Loading

docs/images/hash_calculator.png

249 KB
Loading

docs/images/image_editor.png

1.46 MB
Loading

docs/images/json_editor.png

-50.5 KB
Loading

docs/images/jwt_decoder.png

621 KB
Loading

docs/images/log_generator.png

773 KB
Loading

0 commit comments

Comments
 (0)