From 206dfab5965acd76ca97843c4a891ed34cd976cd Mon Sep 17 00:00:00 2001 From: Serhii Prodan <22973227+serpro69@users.noreply.github.com> Date: Wed, 15 May 2024 19:20:27 +0200 Subject: [PATCH] Update 'about' description in the readme/docs --- README.md | 17 ++++++++++++--- docs/src/orchid/resources/homepage.peb | 30 ++++++++++++++++++++++---- 2 files changed, 40 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index edd869afa..4b2c05ffb 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,11 @@ ### kotlin-faker -> **Generates realistically-looking fake data** -> Just like this fake-logo, but not quite so. +> **Generate realistically-looking fake data for Kotlin, Android, Java and JVM** +> Use kotlin-faker during development and testing to ensure your application data looks as if it was real, just like this *really* fake logo, but not quite so. > fake-logo +> +> *Kotlin-faker is a kotlin port of a popular [ruby faker](https://github.com/stympy/faker) gem.* [![Build Status](https://img.shields.io/github/actions/workflow/status/serpro69/kotlin-faker/build.yml?branch=master&logo=github&style=for-the-badge)](https://github.com/serpro69/kotlin-faker/actions/workflows/build.yml) [![Maven Central](https://img.shields.io/maven-central/v/io.github.serpro69/kotlin-faker?style=for-the-badge)](https://search.maven.org/artifact/io.github.serpro69/kotlin-faker) @@ -23,6 +25,7 @@ - [Install with Maven](#install-with-maven) - [BOM](#bom) - [Additional Fakers](#additional-fakers) + - [Third-Party Extensions](#third-party-extensions) - [Usage](#usage) - [Generating Data](#generating-data) - [CLI](#cli) @@ -34,7 +37,15 @@ ## About -Port of a popular ruby [faker](https://github.com/stympy/faker) gem written in kotlin. Generates realistically looking fake data such as names, addresses, banking details, and many more, that can be used for testing and data-anonymization purposes. +**kotlin-faker: the ultimate fake data generation library for development and testing** + +Kotlin-faker is a comprehensive data-generation library for the JVM. It is most suitable for development, testing, and data anonymization purposes, and can be used with Kotlin, Java, Android, Scala, and other JVM-based projects. Kotlin-faker provides realistic-looking, fake data generation capabilities in various domains like *names*, *addresses*, *internet*, *banking*, *books*, *games*, and [many more](https://serpro69.github.io/kotlin-faker/wiki/data-providers/). + +In fact, kotlin-faker is so good at generating fake data, it almost fooled us into thinking it was real! 🤯 From names that sound like they belong to secret agents 🕴️, to addresses where superheroes 🦸‍♂️ and villains 🦹 might live. + +--- + +⚠️ *P.S. All names, addresses, bank accounts, and other data generated by this library - even those based on real strings - are entirely fictional. All produced data is fake and generated... poorly. The data is completely made up, but the problems that it tries to solve are real. We take no responsibility for any existential crises caused by the eerily convincing fake data. Use with caution!* ⚠️ ## Prerequisites diff --git a/docs/src/orchid/resources/homepage.peb b/docs/src/orchid/resources/homepage.peb index 81079a395..01f7361dc 100644 --- a/docs/src/orchid/resources/homepage.peb +++ b/docs/src/orchid/resources/homepage.peb @@ -123,14 +123,36 @@ layout: 'homepage'
+

+

kotlin-faker: the ultimate fake data generation library for development and testing

+

+

+ Kotlin-faker is a comprehensive data-generation library for the JVM. + It is most suitable for development, testing, and data anonymization purposes, + and can be used with Kotlin, Java, Android, Scala, and other JVM-based projects. + Kotlin-faker provides realistic-looking, fake data generation capabilities in various domains like + names, addresses, internet, banking, books, games, and + {{ anchor(title='many more', collectionType='wiki', collectionId='', itemId='Data Providers') }}. +

- kotlin-faker is a data-generation library intended for use during development and testing, - as well as for data-anonymization purposes. + In fact, kotlin-faker is so good at generating fake data, it almost fooled us into thinking it was real! 🤯 + From names that sound like they belong to secret agents🕴️, to addresses where superheroes 🦸‍♂️ + and villains 🦹 might live.
- It generates realistically looking fake data within a variety of different domains such as names, addresses, - banking details, movies, games, and many more. Just like this fake logo, but not quite so. + Use kotlin-faker during development and testing to ensure your application data looks as if it was real, + just like this really fake logo, but not quite so. +

+ Kotlin-faker is a kotlin port of a popular ruby faker gem. +

+

+ ⚠️ P.S. + All names, addresses, bank accounts, and other data generated by this library - even those based on real strings - are entirely fictional. + All produced data is fake and generated... poorly. + The data is completely made up, but the problems that it tries to solve are real. + We take no responsibility for any existential crises caused by the eerily convincing fake data. + Use with caution! ⚠️


Some of the bits that kotlin-faker gives you are…