Skip to content

Commit

Permalink
Merge pull request #73 from capcom6/docs/app-renaming
Browse files Browse the repository at this point in the history
Fix of legal issues
  • Loading branch information
capcom6 authored Jun 19, 2024
2 parents 7ce1e88 + f7b63ed commit 1f13a60
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 13 deletions.
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,30 @@
[![Issues][issues-shield]][issues-url]
[![Apache 2.0 License][license-shield]][license-url]

# Android SMS Gateway Server
# SMS Gateway for Android™ Server

This server acts as the backend component of the [Android SMS Gateway](https://github.com/capcom6/android-sms-gateway), facilitating the sending of SMS messages through connected Android devices. It includes a RESTful API for message management, integration with Firebase Cloud Messaging (FCM), and a database for persistent storage.
This server acts as the backend component of the [SMS Gateway for Android](https://github.com/capcom6/android-sms-gateway), facilitating the sending of SMS messages through connected Android devices. It includes a RESTful API for message management, integration with Firebase Cloud Messaging (FCM), and a database for persistent storage.

## Table of Contents

- [Android SMS Gateway Server](#android-sms-gateway-server)
- [SMS Gateway for Android™ Server](#sms-gateway-for-android-server)
- [Table of Contents](#table-of-contents)
- [Features](#features)
- [Prerequisites](#prerequisites)
- [Quickstart](#quickstart)
- [Work modes](#work-modes)
- [Contributing](#contributing)
- [License](#license)
- [Legal Notice](#legal-notice)

## Features

- Send SMS messages via a RESTful API.
- Get message status.
- Get the list of connected devices.
- Public and private modes.
- **SMS Messaging**: Dispatch SMS messages through a RESTful API.
- **Message Status**: Retrieve status for sent messages.
- **Device Management**: View information about connected Android devices.
- **Webhooks**: Configure webhooks for event-driven notifications.
- **Health Monitoring**: Access health check endpoints to ensure system integrity.
- **Access Control**: Operate in either public mode for open access or private mode for restricted access.

## Prerequisites

Expand Down Expand Up @@ -74,6 +77,10 @@ Don't forget to give the project a star! Thanks again!

Distributed under the Apache-2.0 license. See [LICENSE](LICENSE) for more information.

## Legal Notice

Android is a trademark of Google LLC.

[contributors-shield]: https://img.shields.io/github/contributors/capcom6/sms-gateway.svg?style=for-the-badge
[contributors-url]: https://github.com/capcom6/sms-gateway/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/capcom6/sms-gateway.svg?style=for-the-badge
Expand Down
4 changes: 2 additions & 2 deletions api/swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
],
"swagger": "2.0",
"info": {
"description": "Provides an API for (Android) SMS Gateway",
"title": "SMS Gateway - API",
"description": "This API provides programmatic access to sending SMS messages on Android devices. Features include sending SMS, checking message status, device management, webhook configuration, and system health checks.",
"title": "SMS Gateway for Android™ API",
"contact": {
"name": "Aleksandr Soloshenko",
"email": "[email protected]"
Expand Down
6 changes: 4 additions & 2 deletions api/swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -321,8 +321,10 @@ info:
contact:
email: [email protected]
name: Aleksandr Soloshenko
description: Provides an API for (Android) SMS Gateway
title: SMS Gateway - API
description: This API provides programmatic access to sending SMS messages on Android
devices. Features include sending SMS, checking message status, device management,
webhook configuration, and system health checks.
title: SMS Gateway for Android™ API
version: '{APP_VERSION}'
paths:
/3rdparty/v1/device:
Expand Down
4 changes: 2 additions & 2 deletions cmd/sms-gateway/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ import (
// @name Authorization
// @description Mobile device token

// @title SMS Gateway - API
// @title SMS Gateway for Android™ API
// @version {APP_VERSION}
// @description Provides an API for (Android) SMS Gateway
// @description This API provides programmatic access to sending SMS messages on Android devices. Features include sending SMS, checking message status, device management, webhook configuration, and system health checks.

// @contact.name Aleksandr Soloshenko
// @contact.email [email protected]
Expand Down

0 comments on commit 1f13a60

Please sign in to comment.