Эх сурвалжийг харах

Поправлен readme

Book Pauk 2 жил өмнө
parent
commit
7fa203eaae
1 өөрчлөгдсөн 19 нэмэгдсэн , 10 устгасан
  1. 19 10
      README.md

+ 19 - 10
README.md

@@ -11,7 +11,10 @@ inpx-web
 или [LightLib](https://lightlib.azurewebsites.net)
 
 [Установка](#usage): просто поместить приложение `inpx-web` в папку с .inpx-файлом и файлами библиотеки (zip-архивами) и запустить.
-По умолчанию, сервер будет доступен по адресу [http://127.0.0.1:12380](http://127.0.0.1:12380)
+
+По умолчанию, веб-сервер будет доступен по адресу [http://127.0.0.1:12380](http://127.0.0.1:12380)
+
+OPDS-сервер доступен по адресу [http://127.0.0.1:12380/opds](http://127.0.0.1:12380/opds)
 
 Для указания местоположения .inpx-файла или папки с файлами библиотеки, воспользуйтесь [параметрами командной строки](#cli).
 Дополнительные параметры сервера настраиваются в [конфигурационном файле](#config).
@@ -30,6 +33,7 @@ inpx-web
 <a id="capabilities" />
 
 ## Возможности программы
+- веб-интерфейс и OPDS-сервер
 - поиск по автору, серии, названию и пр.
 - скачивание книги, копирование ссылки или открытие в читалке
 - возможность указать рабочий каталог при запуске, а также расположение .inpx и файлов библиотеки
@@ -47,7 +51,9 @@ inpx-web
 Там же, при первом запуске, будет создана рабочая директория `.inpx-web`, в которой хранится
 конфигурационный файл `config.json`, файлы базы данных, журналы и прочее.
 
-По умолчанию сервер будет доступен по адресу [http://127.0.0.1:12380](http://127.0.0.1:12380)
+По умолчанию веб-интерфейс будет доступен по адресу [http://127.0.0.1:12380](http://127.0.0.1:12380)
+
+OPDS-сервер доступен по адресу [http://127.0.0.1:12380/opds](http://127.0.0.1:12380/opds)
 
 <a id="cli" />
 
@@ -131,6 +137,14 @@ Options:
     "server": {
         "host": "0.0.0.0",
         "port": "12380"
+    },
+
+    // настройки opds-сервера
+    // user, password используются для Basic HTTP authentication
+    "opds": {
+        "enabled": true,
+        "user": "",
+        "password": ""
     }
 }
 ```
@@ -266,17 +280,12 @@ cd inpx-web
 npm i
 ```
 
-#### Для платформы Windows
-```sh
-npm run build:win
-```
-
-#### Для платформы Linux
+#### Релизы
 ```sh
-npm run build:linux
+npm run release
 ```
 
-Результат сборки будет доступен в каталоге `dist/linux|win` в виде исполнимого (standalone) файла.
+Результат сборки будет доступен в каталоге `dist/release`
 
 <a id="development" />