Updated: docs

runemarcx · Oct 14, 2022 · dd5cceb · dd5cceb
1 parent 3c5274b
commit dd5cceb
Show file tree

Hide file tree

Showing 9 changed files with 390 additions and 12 deletions.
diff --git a/.github/workflows/docs-publish.yml b/.github/workflows/docs-publish.yml
@@ -0,0 +1,20 @@
+name: Publich Docs
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/api
diff --git a/README.md b/README.md
@@ -1,21 +1,89 @@
-# SMS-шлюз
+# Android SMS Gateway
 
-Приложение предназначено для использования Android-устройства в качестве SMS-шлюза для отправки SMS-сообщений.
+This application allows you to use your Android smartphone as an SMS gateway to send SMS via API.
 
-## Требования к UI
+## Features
 
-- [x] Возможность запуска и остановки сервиса
-- [x] Отображение текущего состояния сервиса (запущен/остановлен)
-- [x] Отображение локального и публичного адреса
-- [ ] Отображение и возможность изменения ключа доступа
-- [ ] Возможность изменения порта сервера
+- lightweight;
+- support of Android 5.0 ang above;
+- single API for local and remote server;
+- tracking the status of the message (sent, delivered);
+- start at boot and protection from going to sleep.
+
+## Available modes
+
+- [x] Local web server
+- [ ] Use of sms.capcom.me server in pull and push modes (in progress)
+- [ ] Self-hosted server in pull-mode
+
+## How to use
+
+1. Build the project and install the APK on your phone.
+2. Launch the application. Use the IP address, login and password from the main screen to access the API.
+3. Send messages by connecting to a local web server on the device.
+
+## Roadmap
+
+### UI
+
+- [x] Start and stop service
+- [x] Display the current status of the service (started/stopped)
+- [x] Display local and public addresses
+- [ ] Display and change the api key
+- [ ] Change server port
+- [x] Enable/disable startup on device boot
+- [ ] Select mode (local, server, self-hosted)
+
+### Features
+
+- [x] Save messages to local db
+- [x] Get message status
+- [ ] Pull mode
+- [ ] Push mode
+- [ ] Web notifications to an external server
+
+---
+
+# Android SMS-шлюз
+
+Это приложение позволяет использовать Android-смартфон в качестве SMS-шлюза для отправки SMS через API.
+
+## Функции
+
+- не требовательно к ресурсам;
+- поддержка Android 5.0 и выше;
+- единый API для локального и удаленного сервера;
+- отслеживание состояния сообщения (отправлено, доставлено);
+- запуск при загрузке и защита от ухода в сон.
+
+## Доступные режимы
+
+- [x] Локальный веб-сервер
+- [ ] Использование сервера sms.capcom.me в режимах pull и push (в процессе)
+- [ ] Собственные серверы в режиме pull
+
+## Как использовать
+
+1. Соберите проект и установите APK на телефон.
+2. Запустите приложение. Используйте IP-адрес, логин и пароль с главного экрана для доступа к API.
+3. Отправляйте сообщения, подключившись к локальному веб-серверу на устройстве.
+
+## Дорожная карта
+
+### Пользовательский интерфейс
+
+- [x] Запуск и остановка службы
+- [x] Отображение текущего состояния службы (запущен/остановлен)
+- [x] Отображение локального и публичного адресов
+- [ ] Отображение и изменение ключа доступа
+- [ ] Изменение порта сервера
 - [x] Включение/отключение запуска при загрузке устройства
+- [ ] Выбор режима (локальный, сервер, свой сервер)
 
-## TODO
+### Функции
 
-- [x] Сохранение сообщений в локальной БД
-- [x] Получения информации об отправке сообщений
-- [x] Получение информации о доставке сообщений
+- [x] Сохранять сообщения в локальную БД
+- [x] Получать статус сообщения
 - [ ] Pull-режим
 - [ ] Push-режим
 - [ ] Веб-уведомления на внешний сервер
diff --git a/docs/api/favicon-16x16.png b/docs/api/favicon-16x16.png
diff --git a/docs/api/favicon-32x32.png b/docs/api/favicon-32x32.png
diff --git a/docs/api/index.html b/docs/api/index.html
@@ -0,0 +1,60 @@
+<!-- HTML for static distribution bundle build -->
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <title>Swagger UI</title>
+    <link rel="stylesheet" type="text/css" href="./swagger-ui.css" />
+    <link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32" />
+    <link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16" />
+    <style>
+      html
+      {
+        box-sizing: border-box;
+        overflow: -moz-scrollbars-vertical;
+        overflow-y: scroll;
+      }
+
+      *,
+      *:before,
+      *:after
+      {
+        box-sizing: inherit;
+      }
+
+      body
+      {
+        margin:0;
+        background: #fafafa;
+      }
+    </style>
+  </head>
+
+  <body>
+    <div id="swagger-ui"></div>
+
+    <script src="./swagger-ui-bundle.js" charset="UTF-8"> </script>
+    <script src="./swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
+    <script>
+    window.onload = function() {
+      // Begin Swagger UI call region
+      const ui = SwaggerUIBundle({
+        url: "./swagger.json",
+        dom_id: '#swagger-ui',
+        presets: [
+          SwaggerUIBundle.presets.apis,
+          SwaggerUIStandalonePreset
+        ],
+        layout: "StandaloneLayout",
+        layout: "BaseLayout",
+        deepLinking: true,
+        showExtensions: true,
+        showCommonExtensions: true,
+      });
+      // End Swagger UI call region
+
+      window.ui = ui;
+    };
+  </script>
+  </body>
+</html>
diff --git a/docs/api/swagger-ui-bundle.js b/docs/api/swagger-ui-bundle.js
diff --git a/docs/api/swagger-ui-standalone-preset.js b/docs/api/swagger-ui-standalone-preset.js
diff --git a/docs/api/swagger-ui.css b/docs/api/swagger-ui.css