Merge pull request #8 from vitalygashkov/next

Updated package info and README

README.md

@@ -1,20 +1,20 @@
-# znum
+# Знум
 
-Cкрипт для скачивания книг с электронно-библиотечной системы [Знаниум](https://znanium.com/)
+Инструмент для скачивания книг с электронно-библиотечной системы [Знаниум](https://znanium.com/)
 
 ## Особенности
 
-- Кроссплатформенность: работает на Windows, Linux, MacOS
-- Нет привязки к браузеру: не используются библиотеки для автоматизации браузера типа `puppeteer`, `playwright`, `selenium`
+- **Кроссплатформенность**: работает на Windows, Linux, macOS
+- **Нет привязки к браузеру**: не используются библиотеки для автоматизации браузера типа `puppeteer`, `playwright`, `selenium`
 
 ## Первоначальная настройка
 
-- Скачиваем архив с исходным кодом из секции [Releases](https://github.com/vitalygashkov/znum/releases) или клонируем репозиторий командой `git clone https://github.com/vitalygashkov/znum.git`
-- Скачиваем и устанавливаем [Node.js](https://nodejs.org/en/download/)
-- В папке со скриптом устанавливаем зависимости командой `npm i`
+- Скачай и установи [Node.js](https://nodejs.org/en/download/)
 
 ## Использование
 
-- Запускаем скрипт командой `node znum` или `npm start`
-- При первом запуске будут запрошены имя пользователя и пароль для авторизации (данные сессии сохранятся в `cookies.json`)
-- После успешной авторизации будет предложен ввод ссылки на книгу; вставляем ссылку
+- Открой терминал (перейди в ту директорию, где хочешь хранить книги)
+- Выполни команду `npx znum` (при первом запуске согласись на установку пакета через ввод `y`)
+- Если запускаешь первый раз, то будут будут запрошены имя пользователя и пароль для авторизации (данные сессии сохранятся в `cookies.json`)
+- Далее будет запрошена ссылка на материал; вставь ссылку
+- После завершения скачивания книгу можешь найти в папке `downloads`

package.json

@@ -1,9 +1,30 @@
 {
   "name": "znum",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "author": "Vitaly Gashkov <[email protected]>",
   "description": "Save books from Znanium for offline reading",
   "license": "AGPL-3.0",
+  "keywords": [
+    "pdf",
+    "books",
+    "download",
+    "znanium"
+  ],
+  "readmeFilename": "README.md",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/vitalygashkov/znum"
+  },
+  "bugs": {
+    "url": "https://github.com/vitalygashkov/znum/issues",
+    "email": "[email protected]"
+  },
+  "funding": [
+    {
+      "type": "individual",
+      "url": "https://boosty.to/vitalygashkov/donate"
+    }
+  ],
   "type": "module",
   "main": "znum.js",
   "types": "znum.d.ts",
@@ -14,7 +35,6 @@
     "start": "node znum.js",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
-  "keywords": [],
   "dependencies": {
     "cli-progress": "^3.12.0",
     "got-scraping": "^4.0.6",