diff options
| author | Shinigami <[email protected]> | 2023-03-17 01:28:21 +0100 |
|---|---|---|
| committer | GitHub <[email protected]> | 2023-03-17 00:28:21 +0000 |
| commit | 085562f6ff38dc576b40555b89700d3761455168 (patch) | |
| tree | a1c959c5f4038196e1e13d2989e0fef62e1ed640 /README.md | |
| parent | ee3c3b020c51c357b0ea00a79f2edf82a418b57a (diff) | |
| download | faker-085562f6ff38dc576b40555b89700d3761455168.tar.xz faker-085562f6ff38dc576b40555b89700d3761455168.zip | |
docs: enhance readme (#1918)
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 45 |
1 files changed, 9 insertions, 36 deletions
@@ -18,17 +18,17 @@ ## 📙 API Documentation -[Guide - Getting started](https://fakerjs.dev/guide/) +<h1>⚠️ You are reading the docs for the <a href="https://github.com/faker-js/faker/tree/next">next</a> branch ⚠️</h1> + +Please proceed to the [Getting Started Guide](https://fakerjs.dev/guide/) for the **stable** release of Faker. For detailed API documentation, please select the version of the documentation you are looking for. -| Version | Github | Website | -| :-----: | :----------------------------------------------------: | :------------------------ | -| release | [releases](https://github.com/faker-js/faker/releases) | https://fakerjs.dev/ | -| dev | [next](https://github.com/faker-js/faker/tree/next) | https://next.fakerjs.dev/ | -| v8.x.x | [v8](https://github.com/faker-js/faker/tree/v8) | https://v8.fakerjs.dev/ | -| v7.x.x | [v7](https://github.com/faker-js/faker/tree/v7) | https://v7.fakerjs.dev/ | -| v6.x.x | [v6](https://github.com/faker-js/faker/tree/v6) | https://v6.fakerjs.dev/ | +| Version | Website | +| :---------: | :------------------------ | +| v8 (next) | https://next.fakerjs.dev/ | +| v7 (stable) | https://fakerjs.dev/ | +| v6 (old) | https://v6.fakerjs.dev/ | --- @@ -87,34 +87,7 @@ Thus, limiting the import to a single locale can speed up startup times. ## 💎 Modules -An in-depth overview of the API methods is available in the [documentation](https://fakerjs.dev/guide/). -The API covers the following modules: - -| Module | Example | Output | -| -------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| Airline | `faker.airline.airport()` | `{ name: 'Dallas Fort Worth International Airport', iataCode: 'DFW' }` | -| Animal | `faker.animal.cat()` | Norwegian Forest Cat | -| Color | `faker.color.rgb()` | #cdfcdc | -| Commerce | `faker.commerce.product()` | Polo t-shirt | -| Company | `faker.company.companyName()` | Zboncak and Sons | -| Database | `faker.database.engine()` | MyISAM | -| Datatype | `faker.datatype.uuid()` | 7b16dd12-935e-4acc-8381-b1e457bf0176 | -| Date | `faker.date.past()` | Sat Oct 20 2018 04:19:38 GMT-0700 (Pacific Daylight Time) | -| Finance | `faker.finance.amount()` | ¥23400 (After setting locale) | -| Git | `faker.git.commitMessage()` | feat: add products list page | -| Hacker | `faker.hacker.phrase()` | Try to reboot the SQL bus, maybe it will bypass the virtual application! | -| Helpers | `faker.helpers.arrayElement(['a', 'b', 'c'])` | b | -| Image | `faker.image.url()` | https://picsum.photos/id/165/640/480 <img src="https://picsum.photos/id/165/640/480" height="100"> | -| Internet | `faker.internet.domainName()` | muddy-neuropathologist.net | -| Location | `faker.location.city()` | Lake Raoulfort | -| Lorem | `faker.lorem.paragraph()` | Porro nulla id vero perspiciatis nulla nihil. ... | -| Music | `faker.music.genre()` | R&B | -| Person | `faker.person.firstName()` | Cameron | -| Phone | `faker.phone.phoneNumber()` | +1 291-299-0192 | -| Science | `faker.science.unit()` | `{ name: 'meter', symbol: 'm' }` | -| System | `faker.system.directoryPath()` | /root | -| Vehicle | `faker.vehicle.vehicle()` | Lamborghini Camry | -| Word | `faker.word.adjective()` | adorable | +An in-depth overview of the API methods is available in the documentation for [v7 (stable)](https://fakerjs.dev/api/) and [v8 (next)](https://next.fakerjs.dev/api/). ### Templates |