Skip to content

Commit f33a9b4

Browse files
committed
docs: add table of contents (EN/AR) with section map and deep links
Made-with: Cursor
1 parent 72c7adf commit f33a9b4

2 files changed

Lines changed: 72 additions & 0 deletions

File tree

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,43 @@
88
[![Releases](https://img.shields.io/github/v/release/code-root/gmail-account-creator?label=release&logo=github)](https://github.com/code-root/gmail-account-creator/releases)
99
[![Packages](https://img.shields.io/badge/Packages-npm-24292f?logo=github)](https://github.com/code-root/gmail-account-creator/pkgs/npm/gmail-account-creator)
1010

11+
## Table of contents
12+
13+
**Jump to:** [Arabic README (`README_AR.md`)](README_AR.md#فهرس-المحتويات) · [Repository on GitHub](https://github.com/code-root/gmail-account-creator)
14+
15+
| Section | |
16+
|--------|---|
17+
| [About](#about) | [Repository metadata (GitHub)](#repository-metadata-github) |
18+
| [Features](#features) | [Tech stack](#tech-stack) |
19+
| [How it works (high level)](#how-it-works-high-level) | [Architecture diagrams](#architecture-diagrams) |
20+
| [Module map](#module-map) | [Function reference](#function-reference) |
21+
| [Prerequisites](#prerequisites) | [Installation](#installation) |
22+
| [Configuration highlights](#configuration-highlights) | [Usage](#usage) |
23+
| [Project layout](#project-layout) | [Releases & GitHub Packages](#releases--github-packages) |
24+
| [Suggested GitHub Actions workflows](#suggested-github-actions-workflows-this-stack) | [Maintainer, company & contact](#maintainer-company--contact) |
25+
| [Support this project](#support-this-project) | [Legal & ethics](#legal--ethics) |
26+
| [Links](#links) | |
27+
28+
**Architecture diagrams**
29+
30+
- [System context](#system-context)
31+
- [One account — sequence (happy path)](#one-account--sequence-happy-path)
32+
- [Gmail signup sub-flow (logical)](#gmail-signup-sub-flow-logical)
33+
- [Concurrency model](#concurrency-model)
34+
35+
**Releases & Packages (subsections)**
36+
37+
- [Option A — Automated release (recommended)](#option-a--automated-release-recommended)
38+
- [Option B — “Create a new release” in the GitHub UI](#option-b--create-a-new-release-in-the-github-ui)
39+
- [Install from GitHub Packages](#install-from-github-packages)
40+
- [Publish workflow](#publish-workflow)
41+
42+
**Support**
43+
44+
- [Deposit QR codes (Binance / BSC)](#deposit-qr-codes-scan-in-binance-or-any-bsc-wallet)
45+
46+
---
47+
1148
## About
1249

1350
**Gmail Account Creator** is a Node.js automation toolkit that runs **Google / Gmail signup** inside a real **antidetect browser profile** ([GPM Login](https://gpmlogin.com/) or [Dolphin Anty](https://dolphin-anty.com/)), connects with **Puppeteer**, solves **reCAPTCHA** via the **OMO Captcha** extension, and completes **phone verification** through pluggable **SMS** APIs (SMS Verification, 5SIM Legacy). It supports **proxies**, **human-like input**, and **parallel account jobs** with summarized output to JSON and logs.

README_AR.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,41 @@
55
[![Releases](https://img.shields.io/github/v/release/code-root/gmail-account-creator?label=Releases&logo=github)](https://github.com/code-root/gmail-account-creator/releases)
66
[![Packages](https://img.shields.io/badge/Packages-npm-24292f?logo=github)](https://github.com/code-root/gmail-account-creator/pkgs/npm/gmail-account-creator)
77

8+
## فهرس المحتويات
9+
10+
**انتقال سريع:** [English README (`README.md`)](README.md#table-of-contents) · [المستودع على GitHub](https://github.com/code-root/gmail-account-creator)
11+
12+
| القسم | |
13+
|--------|---|
14+
| [حول المشروع (About)](#حول-المشروع-about) | [وصف المشروع (تفصيل تقني)](#وصف-المشروع-تفصيل-تقني) |
15+
| [المتطلبات قبل البدء](#المتطلبات-قبل-البدء) | [التثبيت — خطوة بخطوة](#التثبيت--خطوة-بخطوة) |
16+
| [التشغيل — أوامر وشرح السلوك](#التشغيل--أوامر-وشرح-السلوك) | [ماذا يحدث داخل البرنامج؟](#ماذا-يحدث-داخل-البرنامج-تسلسل-العمليات) |
17+
| [مخططات توضيحية](#مخططات-توضيحية) | [جدول الوحدات البرمجية](#جدول-الوحدات-البرمجية-ملف--مسؤولية) |
18+
| [مرجع الدوال](#مرجع-الدوال-شرح-مختصر-لكل-دالة-مصدَّرة-أو-método-عام) | [المخرجات والسجلات](#المخرجات-والسجلات) |
19+
| [الإصدارات و GitHub Packages](#الإصدارات-releases-وحزمة-github-packages) | [سير عمل GitHub المقترح](#سير-عمل-github-المقترح-حسب-التقنية) |
20+
| [المطوّر والشركة والتواصل](#المطوّر-والشركة-والتواصل) | [دعم المشروع](#دعم-المشروع-support) |
21+
| [تحذير قانوني وأخلاقي](#تحذير-قانوني-وأخلاقي) | [مراجع سريعة داخل المستودع](#مراجع-سريعة-داخل-المستودع) |
22+
23+
**المخططات (داخل القسم)**
24+
25+
- [السياق العام للنظام](#السياق-العام-للنظام)
26+
- [تسلسل زمني — حساب واحد (المسار الناجح المبسّط)](#تسلسل-زمني--حساب-واحد-المسار-الناجح-المبسّط)
27+
- [مسار التسجيل داخل Gmail (منطقي)](#مسار-التسجيل-داخل-gmail-منطقي)
28+
- [جدول — نموذج التزامن](#جدول--نموذج-التزامن)
29+
30+
**الإصدارات والحزم (أقسام فرعية)**
31+
32+
- [الخيار أ — إصدار تلقائي (مُستحسن)](#الخيار-أ--إصدار-تلقائي-مُستحسن)
33+
- [الخيار ب — من واجهة GitHub: «Create a new release»](#الخيار-ب--من-واجهة-github-create-a-new-release)
34+
- [التثبيت من GitHub Packages](#التثبيت-من-github-packages)
35+
- [النشر التلقائي](#النشر-التلقائي)
36+
37+
**الدعم**
38+
39+
- [رموز QR للإيداع (امسح ضوئياً في Binance أو أي محفظة BSC)](#رموز-qr-للإيداع-امسح-ضوئياً-في-binance-أو-أي-محفظة-bsc)
40+
41+
---
42+
843
## حول المشروع (About)
944

1045
**منشئ حسابات Gmail** أداة أتمتة بـ **Node.js** لتشغيل تدفق **إنشاء حساب Google / Gmail** داخل **بروفايل متصفح مضاد للبصمة** ([GPM Login](https://gpmlogin.com/) أو [Dolphin Anty](https://dolphin-anty.com/))، مع الربط عبر **Puppeteer**، وحل **reCAPTCHA** عبر إضافة **OMO Captcha**، وإكمال **التحقق بالهاتف** عبر واجهات **SMS** (SMS Verification أو 5SIM Legacy). يدعم **البروكسيات**، **إدخالاً شبيهاً بالإنسان**، وتشغيلاً **متوازياً** مع حفظ النتائج في JSON وسجلات.

0 commit comments

Comments
 (0)