Merge pull request #6 from capcom6/feature/docs

Improve documentation
This commit is contained in:
capcom6 2023-11-15 09:37:25 +07:00 committed by GitHub
commit 46709dbe5e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 33 additions and 2 deletions

View File

@ -24,7 +24,7 @@ FROM squidfunk/mkdocs-material AS mkdocs
WORKDIR /docs
RUN pip install mkdocs-render-swagger-plugin
RUN pip install --no-cache-dir mkdocs-render-swagger-plugin
COPY web/mkdocs .

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

View File

Before

Width:  |  Height:  |  Size: 10 KiB

After

Width:  |  Height:  |  Size: 10 KiB

View File

@ -4,6 +4,10 @@ The Android SMS Gateway can work in two modes: with a local server started on th
## Local server
<div align="center">
<img src="/assets/local-server.png" alt="Local server example settings">
</div>
This mode is recommended for sending messages from local network.
1. Start the app on the device.
@ -18,6 +22,10 @@ This mode is recommended for sending messages from local network.
## Cloud server
<div align="center">
<img src="/assets/cloud-server.png" alt="Cloud server example settings">
</div>
If you need to send messages with dynamic or shared device IP, you can use the cloud server. The best part? No registration, email, or phone number is required to start using it.
1. Start the app on the device.

View File

@ -1,6 +1,8 @@
# Android SMS Gateway
![Project logo](logo.png)
<div align="center">
<img src="/assets/logo.png" alt="Logo">
</div>
Android SMS Gateway turns your Android smartphone into an SMS gateway. It's a lightweight application allowing you to send SMS messages programmatically via API. This makes it ideal for integrating SMS functionality into your own applications or services.

View File

@ -2,6 +2,27 @@ site_name: Android SMS Gateway
site_url: https://sms.capcom.me
theme:
name: material
palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to system preference
nav:
- Home: index.md
- Installation: installation.md