Skip to content

Commit

Permalink
Update 'about' description in the readme/docs
Browse files Browse the repository at this point in the history
  • Loading branch information
serpro69 committed May 15, 2024
1 parent aaa017c commit 206dfab
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 7 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@

### <a href="https://github.com/serpro69/kotlin-faker"> <img src=./logo/name.png alt="kotlin-faker"/> </a>

> **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.
> <img src=./logo/kotlin_faker.png height="144" alt="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)
Expand All @@ -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)
Expand All @@ -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

Expand Down
30 changes: 26 additions & 4 deletions docs/src/orchid/resources/homepage.peb
Original file line number Diff line number Diff line change
Expand Up @@ -123,14 +123,36 @@ layout: 'homepage'

<section class="columns is-centered">
<div class="column is-8">
<p class="description-text">
<h3>kotlin-faker: the ultimate fake data generation library for development and testing</h3>
</p>
<div class="content is-medium">
<p class="description-text">
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
<i>names, addresses, internet, banking, books, games</i>, and
{{ anchor(title='many more', collectionType='wiki', collectionId='', itemId='Data Providers') }}.
</p>
<img src="{{ 'assets/images/logo.png' | asset }}" alt="faker-logo" class="description-logo">
<p class="description-text">
<b>kotlin-faker</b> 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.
<br>
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 <i>really</i> fake logo, but not quite so.
<br><br>
<i>Kotlin-faker is a kotlin port of a popular <a href="https://github.com/stympy/faker">ruby faker</a> gem.</i>
</p>
<p class="description-text">
⚠️ <i>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!</i> ⚠️
</p>
<br>
<p style="clear:both;">Some of the bits that kotlin-faker gives you are…</p>
Expand Down

0 comments on commit 206dfab

Please sign in to comment.