Skip to content

Commit 22a1c04

Browse files
committed
Update readme
1 parent f3bcb0e commit 22a1c04

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ Generate realistic data through AI and the large amount of data stored in our sy
99
[![npm downloads](https://badgen.net/npm/dm/magikfake)](https://www.npmjs.com/package/magikfake)
1010
</div>
1111

12-
## Features
12+
## 🚀 Features
1313

1414
- 🪄 AI Engine - Fake data are generated through an AI engine.
1515
- 🔆 Flexible scheme - User can define a schema similar to mongoose, using primitive types.
1616
- 🌏 Localization - Data are translated into 5 languages: 🇬🇧, 🇮🇹, 🇪🇸, 🇩🇪, 🇫🇷
1717
- 🏦 Data store - Large amount of data stored in our system.
1818
- 💾 Save schema - User can save a schema to use it at a later time.
1919

20-
## Install
20+
## 📦 Install
2121

2222
```bash
2323
npm install magikfake@beta
@@ -31,7 +31,7 @@ Use it for testing now.
3131

3232
---
3333

34-
## Introduction
34+
## 🪄 Introduction
3535

3636
Magikfake was created to leverage the power of **AI** in generating data that closely resembles real-world data.
3737

@@ -51,7 +51,7 @@ For each property defined, the system analyzes the key and type to generate the
5151

5252
Unlike other fake data generation systems, Magikfake simplifies schema definition by allowing the user to assign a **primitive** type (**string**, **number**, **date**, **boolean**, **objectId**, etc...) to each property, without the need for a custom type to obtain the desired value.
5353

54-
## Usage and access limits
54+
## 💻 Usage and access limits
5555

5656
To use Magikfake's library for generating fake data, users must obtain an API key. This can be done by registering for an account on the Magikfake website at the following link: https://app.magikfake.com.
5757

@@ -65,11 +65,11 @@ By obtaining an API key and subscribing to a Magikfake plan, users can quickly a
6565
| Standard | Available in the official version | Available in the official version |
6666
| Pro | Available in the official version | Available in the official version |
6767

68-
## Try it online
68+
## ⚡️ Try it online
6969

7070
You can try Magikfake online by visiting https://magikfake.com. 1,000,000 tokens are available daily and shared among site users. If you run out of tokens, you can register on the site to take advantage of the 25,000 tokens available monthly.
7171

72-
## Supported types and validations
72+
## 📖 Supported types and validations
7373

7474
Magikfake supports a variety of primitive types that can be assigned to the properties in the schema.
7575

@@ -161,7 +161,7 @@ The types supported are:
161161
| <pre lang="json">{&#13; "users": [&#13; { &#13; "id": "objectId",&#13; "firstName": "string", &#13; "lastName": "string", &#13; "age": "number", &#13; "isFirstLogin": "boolean", &#13; "birthDate": "date" &#13; }&#13; ]&#13;}</pre>or<pre lang="json">{&#13; "users": {&#13; "type": [{ &#13; "id": "objectId",&#13; "firstName": "string", &#13; "lastName": "string", &#13; "age": "number", &#13; "isFirstLogin": "boolean", &#13; "birthDate": "date" &#13; }]&#13; }&#13;}</pre> | the **users** field of type **array** indicates a list of values of type object, where it is possible to define fields of various types. |
162162

163163

164-
## Schema example
164+
## 📜 Schema example
165165

166166
Here is a schema example with various types of fields:
167167

@@ -202,7 +202,7 @@ The fake data generated will have this type of structure:
202202
The result will try to provide a compatibility between the keys and the types, this to make the data as truthful as possible.
203203

204204

205-
## Fake data
205+
## 🎯​ Fake data
206206

207207
### Generate fake data
208208

@@ -352,7 +352,7 @@ const tokenStatus = await client.fakeData.tokenStatus()
352352
tokenStatus(): Promise<ITokenStatus>
353353
```
354354

355-
## Schema
355+
## 📜 Schema
356356

357357
With Magikfake, users have the ability to save their defined schema for future use.
358358

@@ -668,7 +668,7 @@ const response = await client.schema.delete("642ab202f419d954a2b35605")
668668
true
669669
```
670670

671-
## Errors
671+
## Errors
672672

673673
When using the methods provided by the Magikfake library, it is possible that an exception may be raised. If this occurs, the user will receive an error message indicating the nature of the issue.
674674

@@ -682,7 +682,7 @@ Some of the errors that may be encountered include:
682682
In any of these cases, the user should review their code and make any necessary corrections or updates to address the error. By working with the Magikfake library and handling errors appropriately, users can generate high-quality, realistic fake data for a variety of purposes.
683683

684684

685-
## Supports and issue
685+
## 🆘 Supports and issue
686686

687687
If you need support you can contact us at the following email: [email protected].
688688

0 commit comments

Comments
 (0)