Skip to content

Commit fc1afa5

Browse files
committed
docs: refactor documentation structure and enhance contents navigation
- Expand and reorganize the table of contents for improved clarity and navigation - Add more detailed section links for configuration, installation, usage, API, deployment, and FAQ - Move and reformat the explanation of platform codes to the Support Platform section - Remove duplicate and less relevant section references from the contents Signed-off-by: appleboy <[email protected]>
1 parent f1c70ef commit fc1afa5

File tree

1 file changed

+27
-3
lines changed

1 file changed

+27
-3
lines changed

README.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,23 +36,47 @@ curl -X POST http://localhost:8088/api/push \
3636
}'
3737
```
3838

39-
📱 **Platform codes**: `1` = iOS (APNS), `2` = Android (FCM), `3` = Huawei (HMS)
40-
4139
## Contents
4240

4341
- [Quick Start](#quick-start) - Get up and running in 3 steps
4442
- [Support Platform](#support-platform) - iOS, Android, Huawei
4543
- [Features](#features) - What gorush can do
46-
- [Installation](#installation) - Binary, package managers, Docker, source
4744
- [Configuration](#configuration) - YAML config and options
45+
- [Basic Configuration](#basic-configuration)
46+
- [Advanced Configuration](#advanced-configuration)
47+
- [Installation](#installation) - Binary, package managers, Docker, source
48+
- [Recommended: Install Script](#recommended-install-script)
49+
- [Manual Download](#manual-download)
50+
- [Package Managers](#package-managers)
51+
- [Build from Source](#build-from-source)
52+
- [Docker](#docker)
4853
- [Usage](#usage) - CLI commands and REST API examples
54+
- [Starting the Server](#starting-the-server)
55+
- [Command Line Notifications](#command-line-notifications)
56+
- [REST API Usage](#rest-api-usage)
57+
- [CLI Options Reference](#cli-options-reference)
4958
- [Web API](#web-api) - Complete API reference
59+
- [Overview](#overview)
60+
- [Send Notifications](#send-notifications---post-apipush)
61+
- [Statistics APIs](#statistics-apis)
62+
- [Advanced Configuration](#advanced-configuration-1)
5063
- [Deployment](#deployment) - Docker, Kubernetes, AWS Lambda, gRPC
64+
- [Docker](#docker-1)
65+
- [Kubernetes](#kubernetes)
66+
- [AWS Lambda](#aws-lambda)
67+
- [Netlify Functions](#netlify-functions)
68+
- [gRPC Service](#grpc-service)
5169
- [FAQ](#faq) - Common issues and best practices
70+
- [Common Issues](#common-issues)
71+
- [Performance Tips](#performance-tips)
72+
- [Security Best Practices](#security-best-practices)
73+
- [Stargazers over time](#stargazers-over-time)
5274
- [License](#license)
5375

5476
## Support Platform
5577

78+
📱 Platform codes: `1` = iOS (APNS), `2` = Android (FCM), `3` = Huawei (HMS)
79+
5680
- [APNS](https://developer.apple.com/documentation/usernotifications)
5781
- [FCM](https://firebase.google.com/)
5882
- [HMS](https://developer.huawei.com/consumer/en/hms/)

0 commit comments

Comments
 (0)