Enhance Documentation with More Examples

yayakm / RegexStringGenerator

A Java library designed to generate random String that matches specified regular expressions. This tool is invaluable for developers and testers who require dynamically generated data that adheres to specific patterns, such as creating unique IDs, keys under constraints.

Apache License 2.0

4 stars 1 forks source link

Enhance Documentation with More Examples #19

Open yayakm opened 1 month ago

yayakm commented 1 month ago

Description: Update the README and other relevant documentation to include more detailed examples and a broader scope of use cases. This should help users understand the capabilities of the library and how to implement features effectively.

Acceptance Criteria:

Expanded examples that include simple and complex regex patterns.
Documentation of all public API methods.
Guides on common pitfalls and best practices with regex in the library.
Version history and updates log.

kycasdzxc commented 1 month ago

@yayakm Can you assign this problem to me? I am interested in this project. Also, If you don't mind, I'd like to contribute to improving the code as well.

yayakm commented 1 month ago

Thank you @kycasdzxc for your interest, all contributions are welcome. Feel free to get back to me if you have any questions.

kycasdzxc commented 1 month ago

Thank you @kycasdzxc for your interest, all contributions are welcome. Feel free to get back to me if you have any questions.

I have a question. Can I input other objects besides the new Random() object? Why not just assign new Random() when creating an object? I don't understand why an object is being received as a constructor parameter.

yayakm commented 1 month ago

I have a question. Can I input other objects besides the new Random() object? Why not just assign new Random() when creating an object? I don't understand why an object is being received as a constructor parameter.

You have the choice of not supplying a random object, in which case an instance will be created.
We have the option of providing a Random object, as some applications prefer to use their own custom random object, which already has a well-defined behavior.