Skip to content

Commit 795032a

Browse files
authored
update license and README (#5)
1 parent 875405c commit 795032a

2 files changed

Lines changed: 175 additions & 169 deletions

File tree

‎README.md‎

Lines changed: 167 additions & 166 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
Java Faker
2-
==========
1+
# Java Faker
32

43
[![Maven Status](https://maven-badges.herokuapp.com/maven-central/com.github.javafaker/javafaker/badge.svg?style=flat)](http://mvnrepository.com/artifact/com.github.javafaker/javafaker)
5-
[![Build Status](https://travis-ci.org/DiUS/java-faker.svg?branch=master)](https://travis-ci.org/DiUS/java-faker)
64
[![Coverage Status](https://coveralls.io/repos/DiUS/java-faker/badge.svg)](https://coveralls.io/r/DiUS/java-faker)
75
[![License](http://img.shields.io/:license-apache-brightgreen.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
86

97
This library is a port of Ruby's [faker](https://github.com/stympy/faker) gem (as well as Perl's Data::Faker library) that generates fake data.
108
It's useful when you're developing a new project and need some pretty data for showcase.
119

12-
Usage
13-
-----
14-
In pom.xml, add the following xml stanza between `<dependencies> ... </dependencies>`
10+
## Usage
11+
12+
### Adding dependency
13+
14+
For maven users add the following to your `pom.xml`:
1515

1616
```xml
1717
<dependency>
@@ -21,187 +21,188 @@ In pom.xml, add the following xml stanza between `<dependencies> ... </dependenc
2121
</dependency>
2222
```
2323

24-
For gradle users, add the following to your build.gradle file.
24+
For gradle users, add one of the following to your `build.gradle` file depending on the style you use:
25+
26+
```groovy
27+
implementation 'com.github.javafaker:javafaker:1.0.2'
28+
```
2529

2630
```groovy
27-
dependencies {
28-
implementation 'com.github.javafaker:javafaker:1.0.2'
29-
}
31+
implementation group: 'com.github.javafaker', name: 'javafaker', version: '1.0.2'
32+
```
3033

34+
```kotlin
35+
implementation("com.github.javafaker:javafaker:1.0.2")
3136
```
3237

33-
In your Java code
38+
### In your Java code
3439

3540
```java
3641
Faker faker = new Faker();
37-
3842
String name = faker.name().fullName(); // Miss Samanta Schmidt
3943
String firstName = faker.name().firstName(); // Emory
4044
String lastName = faker.name().lastName(); // Barton
41-
4245
String streetAddress = faker.address().streetAddress(); // 60018 Sawayn Brooks Suite 449
4346
```
4447

4548
This is a [demo web application](https://java-faker.herokuapp.com/) that uses the library.
4649

47-
Javadoc
48-
-----
49-
http://dius.github.io/java-faker/apidocs/index.html
50+
## Javadoc
5051

52+
http://dius.github.io/java-faker/apidocs/index.html
5153

52-
Contributions
53-
-------------
54-
See [CONTRIBUTING.md](https://github.com/DiUS/java-faker/blob/master/CONTRIBUTING.md)
55-
56-
57-
Fakers
58-
-----
59-
* Address
60-
* Ancient
61-
* Animal
62-
* App
63-
* Aqua Teen Hunger Force
64-
* Artist
65-
* Avatar
66-
* Back To The Future
67-
* Aviation
68-
* Basketball
69-
* Beer
70-
* Bojack Horseman
71-
* Book
72-
* Bool
73-
* Business
74-
* ChuckNorris
75-
* Cat
76-
* Code
77-
* Coin
78-
* Color
79-
* Commerce
80-
* Company
81-
* Crypto
82-
* DateAndTime
83-
* Demographic
84-
* Disease
85-
* Dog
86-
* DragonBall
87-
* Dune
88-
* Educator
89-
* Esports
90-
* EnglandFootBall
91-
* File
92-
* Finance
93-
* Food
94-
* Friends
95-
* FunnyName
96-
* GameOfThrones
97-
* Gender
98-
* Hacker
99-
* HarryPotter
100-
* Hipster
101-
* HitchhikersGuideToTheGalaxy
102-
* Hobbit
103-
* HowIMetYourMother
104-
* IdNumber
105-
* Internet
106-
* Job
107-
* Kaamelott
108-
* LeagueOfLegends
109-
* Lebowski
110-
* LordOfTheRings
111-
* Lorem
112-
* Matz
113-
* Music
114-
* Name
115-
* Nation
116-
* Number
117-
* Options
118-
* Overwatch
119-
* PhoneNumber
120-
* Photography
121-
* Pokemon
122-
* Princess Bride
123-
* Relationship Terms
124-
* RickAndMorty
125-
* Robin
126-
* RockBand
127-
* Shakespeare
128-
* Sip
129-
* SlackEmoji
130-
* Space
131-
* StarCraft
132-
* StarTrek
133-
* Stock
134-
* Superhero
135-
* Team
136-
* TwinPeaks
137-
* University
138-
* Weather
139-
* Witcher
140-
* Yoda
141-
* Zelda
142-
143-
Usage with Locales
144-
-----
54+
## Contributions
55+
56+
Contributions are welcome!
57+
58+
See [CONTRIBUTING.md](https://github.com/TheJavaGuy/java-faker/blob/master/CONTRIBUTING.md)
59+
60+
## Fakers
61+
62+
- Address
63+
- Ancient
64+
- Animal
65+
- App
66+
- Aqua Teen Hunger Force
67+
- Artist
68+
- Avatar
69+
- Back To The Future
70+
- Aviation
71+
- Basketball
72+
- Beer
73+
- Bojack Horseman
74+
- Book
75+
- Bool
76+
- Business
77+
- ChuckNorris
78+
- Cat
79+
- Code
80+
- Coin
81+
- Color
82+
- Commerce
83+
- Company
84+
- Crypto
85+
- DateAndTime
86+
- Demographic
87+
- Disease
88+
- Dog
89+
- DragonBall
90+
- Dune
91+
- Educator
92+
- Esports
93+
- EnglandFootBall
94+
- File
95+
- Finance
96+
- Food
97+
- Friends
98+
- FunnyName
99+
- GameOfThrones
100+
- Gender
101+
- Hacker
102+
- HarryPotter
103+
- Hipster
104+
- HitchhikersGuideToTheGalaxy
105+
- Hobbit
106+
- HowIMetYourMother
107+
- IdNumber
108+
- Internet
109+
- Job
110+
- Kaamelott
111+
- LeagueOfLegends
112+
- Lebowski
113+
- LordOfTheRings
114+
- Lorem
115+
- Matz
116+
- Music
117+
- Name
118+
- Nation
119+
- Number
120+
- Options
121+
- Overwatch
122+
- PhoneNumber
123+
- Photography
124+
- Pokemon
125+
- Princess Bride
126+
- Relationship Terms
127+
- RickAndMorty
128+
- Robin
129+
- RockBand
130+
- Shakespeare
131+
- Sip
132+
- SlackEmoji
133+
- Space
134+
- StarCraft
135+
- StarTrek
136+
- Stock
137+
- Superhero
138+
- Team
139+
- TwinPeaks
140+
- University
141+
- Weather
142+
- Witcher
143+
- Yoda
144+
- Zelda
145+
146+
## Usage with Locales
145147

146148
```java
147149
Faker faker = new Faker(new Locale("YOUR_LOCALE"));
148150
```
149151

150-
Supported Locales
151-
-----
152-
* bg
153-
* ca
154-
* ca-CAT
155-
* da-DK
156-
* de
157-
* de-AT
158-
* de-CH
159-
* en
160-
* en-AU
161-
* en-au-ocker
162-
* en-BORK
163-
* en-CA
164-
* en-GB
165-
* en-IND
166-
* en-MS
167-
* en-NEP
168-
* en-NG
169-
* en-NZ
170-
* en-PAK
171-
* en-SG
172-
* en-UG
173-
* en-US
174-
* en-ZA
175-
* es
176-
* es-MX
177-
* fa
178-
* fi-FI
179-
* fr
180-
* he
181-
* hu
182-
* in-ID
183-
* it
184-
* ja
185-
* ko
186-
* nb-NO
187-
* nl
188-
* pl
189-
* pt
190-
* pt-BR
191-
* ru
192-
* sk
193-
* sv
194-
* sv-SE
195-
* tr
196-
* uk
197-
* vi
198-
* zh-CN
199-
* zh-TW
200-
201-
TODO
202-
----
203-
- Port more classes over as there are more entries in the yml file that we don't have classes for
204-
205-
LICENSE
206-
-------
152+
## Supported Locales
153+
154+
- bg
155+
- ca
156+
- ca-CAT
157+
- da-DK
158+
- de
159+
- de-AT
160+
- de-CH
161+
- en
162+
- en-AU
163+
- en-au-ocker
164+
- en-BORK
165+
- en-CA
166+
- en-GB
167+
- en-IND
168+
- en-MS
169+
- en-NEP
170+
- en-NG
171+
- en-NZ
172+
- en-PAK
173+
- en-SG
174+
- en-UG
175+
- en-US
176+
- en-ZA
177+
- es
178+
- es-MX
179+
- fa
180+
- fi-FI
181+
- fr
182+
- he
183+
- hu
184+
- in-ID
185+
- it
186+
- ja
187+
- ko
188+
- nb-NO
189+
- nl
190+
- pl
191+
- pt
192+
- pt-BR
193+
- ru
194+
- sk
195+
- sv
196+
- sv-SE
197+
- tr
198+
- uk
199+
- vi
200+
- zh-CN
201+
- zh-TW
202+
203+
## LICENSE
204+
205+
Copyright (c) 2025 TheJavaGuy. See the LICENSE file for license rights and limitations.
206+
207+
For previous work:
207208
Copyright (c) 2019 DiUS Computing Pty Ltd. See the LICENSE file for license rights and limitations.

‎pom.xml‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,16 @@
2727
</license>
2828
</licenses>
2929
<scm>
30-
<connection>scm:git:git://github.com/DiUS/java-faker.git</connection>
31-
<developerConnection>scm:git:git@github.com:DiUS/java-faker.git</developerConnection>
32-
<url>git://github.com/DiUS/java-faker.git</url>
30+
<connection>scm:git:git://github.com/TheJavaGuy/java-faker.git</connection>
31+
<developerConnection>scm:git:git@github.com:TheJavaGuy/java-faker.git</developerConnection>
32+
<url>git://github.com/TheJavaGuy/java-faker.git</url>
3333
</scm>
3434
<developers>
35+
<developer>
36+
<id>thejavaguy</id>
37+
<name>Ivan Milosavljević</name>
38+
<email>TheJavaGuy@yandex.com</email>
39+
</developer>
3540
<developer>
3641
<id>renshao</id>
3742
<name>Ren Shao</name>

0 commit comments

Comments
 (0)