Skip to content

Commit 108ad1e

Browse files
committed
updated README
1 parent f974905 commit 108ad1e

1 file changed

Lines changed: 30 additions & 1 deletion

File tree

README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,33 @@
22
[![Build Status](https://travis-ci.org/RandomAPI/Randomuser.me-Node.svg?branch=master)](https://travis-ci.org/RandomAPI/Randomuser.me-Node)
33
[![Stories in Ready](https://badge.waffle.io/RandomAPI/Randomuser.me-Node.png?label=ready&title=Ready)](https://waffle.io/RandomAPI/Randomuser.me-Node)
44

5-
Randomuser.me in Node.js
5+
### About
6+
This is the source code that powers the randomuser.me User Generator.
7+
8+
Our goal is to have a very diverse database that consists of data unique to different nationalities.
9+
While some places might have an SSN or their phone number might be formatted a certain way, other places usually follow a completely different set of rules.
10+
11+
Help us make the Random User Generator better by contributing to our database and teaching us the proper way of formatting data for different nationalities.
12+
13+
### Guidelines
14+
If you would like to help contribute data specific to a region, please keep these few rules in mind:
15+
16+
1. Only add new nat data to the `api/.nextRelease` directory...
17+
18+
2. Please keep all of the data organized.
19+
- Keep US data in the US directory, AU in the AU directory, etc.
20+
21+
3. No duplicates. Make sure that the data you are adding isn't already on the list.
22+
- An easy way to remove duplicates from your file and sort:
23+
```sh
24+
sort -u <file> -o <file>
25+
```
26+
27+
4\. Please don't submit requests that say "make this nationality". We will accept helpful contributions, but not orders :)
28+
29+
### What if I want to add a new nationality?
30+
Go ahead! We will gladly accept new regions if they follow the guidelines above.
31+
Just place your files in a new directory in the `api/.nextRelease/data` folder with the appropriate 2 letter ISO Country Code (http://countrycode.org). Follow the format of the US folder for reference.
32+
33+
### How to contact us
34+
If you have any questions, feel free to ask us on our Twitter page [@randomapi](https://twitter.com/randomapi).

0 commit comments

Comments
 (0)