Merge pull request #489 from AlexXanderGrib/master

chore(docs): prettified readme files
negezor · May 31, 2022 · f4dde5a · f4dde5a
2 parents 82139e2 + e2e4fae
commit f4dde5a
Show file tree

Hide file tree

Showing 8 changed files with 188 additions and 138 deletions.
diff --git a/README.md b/README.md
@@ -6,34 +6,45 @@
 <a href="https://www.codacy.com/app/negezor/vk-io"><img src="https://img.shields.io/codacy/grade/25ee36d46e6e498981a74f8b0653aacc.svg?style=flat-square" alt="Code quality"></a>
 </p>
 
-VK-IO - This is a powerful [Node.js](https://nodejs.org) module that allows you to easily interact with the VK API 🚀
+> **VK-IO** - This is a powerful [Node.js](https://nodejs.org) module that allows you to easily interact with the VK API 🚀
 
 | 📖 [Documentation](https://negezor.github.io/vk-io/) | 🤖 [Examples](docs/examples/) |
-|------------------------------------------------------|--------------------------------|
+| ---------------------------------------------------- | ----------------------------- |
 
 ## Features
-- 100% coverage of the VKontakte API
-- Predictable abstraction
-- Works with large collections of data
-- Support for all types of authorization, including via login and password
-- Typings
 
-## Installation
-> **[Node.js](https://nodejs.org/) 12.20.0 or newer is required**  
+1. **Complete.** `100%` coverage of the VK API
+2. **Simple.** Predictable abstraction of VK API. 1 to 1 mapping of API method
+   ```javascript
+   vk.api.users.get({ ... });
+   ```
+3. **Reliable.** The library is written in **TypeScript** and covered by tests.
+4. **Powerful.** Supports following additional features:
+   - **Proxy** support via Custom Agents;
+   - Automatic **request parallelization** for processing massive amounts of requests to API;
+   - User [Authorization](./packages/authorization/README.md) (even with login and password);
+   - [Ecosystem for bot development](#useful-modules-that-may-be-useful-to-you).
 
-### Yarn
-Recommended
-```
-yarn add vk-io
-```
+## 📦 Installation
 
-### NPM
-```
-npm i vk-io
-```
+> **[Node.js](https://nodejs.org/) 12.20.0 or newer is required**
+
+- **Using `Yarn`** (recommended)
+  ```shell
+  yarn add vk-io
+  ```
+- **Using `npm`**
+  ```shell
+  npm i vk-io
+  ```
+- **Using `pnpm`**
+  ```shell
+  pnpm add vk-io
+  ```
 
 ## Example usage
-```js
+
+```javascript
 import { VK } from 'vk-io';
 
 const vk = new VK({
@@ -52,17 +63,18 @@ run().catch(console.log);
 ```
 
 ## Community
+
 ### Useful modules that may be useful to you
 
-* [@vk-io/stateless-prompt](packages/stateless-prompt): Simple implementation of stateless prompt
-* [@vk-io/authorization](packages/authorization): Authorization by login & password, and etc... 
-* [@vk-io/streaming](packages/streaming): Receiving data with Streaming API
-* [@vk-io/session](packages/session): Simple implementation of the sessions
-* [@vk-io/scenes](packages/scenes): Simple implementation of middleware-based scene management
-* [@vk-io/hear](packages/hear): Simple implementation of the hears
-* [vk-io-question](https://github.com/fakemancat/vk-io-question): Simple promise-based prompt
-* [vk-io-pages](https://github.com/MrZillaGold/vk-io-pages): Dynamic pages pagination module
-* [henta](https://github.com/u14-team/henta): Simple VK bot engine
-* [vk-io-redis-storage](https://github.com/xtcry/vk-io-redis-storage): Simple storage add-on for [@vk-io/session](packages/session)
+- [@vk-io/stateless-prompt](packages/stateless-prompt): Simple implementation of stateless prompt
+- [@vk-io/authorization](packages/authorization): Authorization by login & password, and etc...
+- [@vk-io/streaming](packages/streaming): Receiving data with Streaming API
+- [@vk-io/session](packages/session): Simple implementation of the sessions
+- [@vk-io/scenes](packages/scenes): Simple implementation of middleware-based scene management
+- [@vk-io/hear](packages/hear): Simple implementation of the hears
+- [vk-io-question](https://github.com/fakemancat/vk-io-question): Simple promise-based prompt
+- [vk-io-pages](https://github.com/MrZillaGold/vk-io-pages): Dynamic pages pagination module
+- [henta](https://github.com/u14-team/henta): Simple VK bot engine
+- [vk-io-redis-storage](https://github.com/xtcry/vk-io-redis-storage): Simple storage add-on for [@vk-io/session](packages/session)
 
 > If you want to add your module in the list, create a [new issue](https://github.com/negezor/vk-io/issues/new) in the repository.
diff --git a/packages/authorization/README.md b/packages/authorization/README.md
@@ -1,27 +1,32 @@
 # VK-IO Authorization
+
 <a href="https://www.npmjs.com/package/@vk-io/authorization"><img src="https://img.shields.io/npm/v/@vk-io/authorization.svg?style=flat-square" alt="NPM version"></a>
 <a href="https://github.com/negezor/vk-io/actions/workflows/tests.yml"><img src="https://img.shields.io/github/workflow/status/negezor/vk-io/VK-IO CI?style=flat-square" alt="Build Status"></a>
 <a href="https://www.npmjs.com/package/@vk-io/authorization"><img src="https://img.shields.io/npm/dt/@vk-io/authorization.svg?style=flat-square" alt="NPM downloads"></a>
 <a href="https://www.codacy.com/app/negezor/vk-io"><img src="https://img.shields.io/codacy/grade/25ee36d46e6e498981a74f8b0653aacc.svg?style=flat-square" alt="Code quality"></a>
 
-VK-IO Authorization API - Separated module for authorization by login & password, and etc... ⚙️
+> VK-IO Authorization API - Separated module for authorization by login & password, and etc... ⚙️
 
-## Installation
-> **[Node.js](https://nodejs.org/) 12.20.0 or newer is required** 
+## 📦 Installation
 
-### Yarn
-Recommended
-```
-yarn add @vk-io/authorization
-```
+> **[Node.js](https://nodejs.org/) 12.20.0 or newer is required**
 
-### NPM
-```
-npm i @vk-io/authorization
-```
+- **Using `Yarn`** (recommended)
+  ```shell
+  yarn add @vk-io/authorization
+  ```
+- **Using `npm`**
+  ```shell
+  npm i @vk-io/authorization
+  ```
+- **Using `pnpm`**
+  ```shell
+  pnpm add @vk-io/authorization
+  ```
 
 ## Example usage
-```js
+
+```javascript
 import { CallbackService } from 'vk-io';
 import { DirectAuthorization, officialAppCredentials } from '@vk-io/authorization';
 
@@ -56,6 +61,6 @@ async function run() {
 run().catch(console.error);
 ```
 
-## Additional info 
+## Additional info
 
 The module also supports `ImplicitFlowUser`, `ImplicitFlowGroup` and `AccountVerification`
diff --git a/packages/hear/README.md b/packages/hear/README.md
@@ -1,27 +1,32 @@
 # VK-IO Hear
+
 <a href="https://www.npmjs.com/package/@vk-io/hear"><img src="https://img.shields.io/npm/v/@vk-io/hear.svg?style=flat-square" alt="NPM version"></a>
 <a href="https://github.com/negezor/vk-io/actions/workflows/tests.yml"><img src="https://img.shields.io/github/workflow/status/negezor/vk-io/VK-IO CI?style=flat-square" alt="Build Status"></a>
 <a href="https://www.npmjs.com/package/@vk-io/hear"><img src="https://img.shields.io/npm/dt/@vk-io/hear.svg?style=flat-square" alt="NPM downloads"></a>
 <a href="https://www.codacy.com/app/negezor/vk-io"><img src="https://img.shields.io/codacy/grade/25ee36d46e6e498981a74f8b0653aacc.svg?style=flat-square" alt="Code quality"></a>
 
-VK-IO Hear - Simple implementation of the hears ⚙️
+> VK-IO Hear - Simple implementation of the hears ⚙️
 
-## Installation
-> **[Node.js](https://nodejs.org/) 12.20.0 or newer is required** 
+## 📦 Installation
 
-### Yarn
-Recommended
-```
-yarn add @vk-io/hear
-```
+> **[Node.js](https://nodejs.org/) 12.20.0 or newer is required**
 
-### NPM
-```
-npm i @vk-io/hear
-```
+- **Using `Yarn`** (recommended)
+  ```shell
+  yarn add @vk-io/hear
+  ```
+- **Using `npm`**
+  ```shell
+  npm i @vk-io/hear
+  ```
+- **Using `pnpm`**
+  ```shell
+  pnpm add @vk-io/hear
+  ```
 
 ## Example usage
-```js
+
+```javascript
 import { VK, MessageContext } from 'vk-io';
 
 import { HearManager } from '@vk-io/hear';

diff --git a/packages/scenes/README.md b/packages/scenes/README.md
@@ -1,27 +1,32 @@
 # VK-IO Scenes
+
 <a href="https://www.npmjs.com/package/@vk-io/scenes"><img src="https://img.shields.io/npm/v/@vk-io/scenes.svg?style=flat-square" alt="NPM version"></a>
 <a href="https://github.com/negezor/vk-io/actions/workflows/tests.yml"><img src="https://img.shields.io/github/workflow/status/negezor/vk-io/VK-IO CI?style=flat-square" alt="Build Status"></a>
 <a href="https://www.npmjs.com/package/@vk-io/scenes"><img src="https://img.shields.io/npm/dt/@vk-io/scenes.svg?style=flat-square" alt="NPM downloads"></a>
 <a href="https://www.codacy.com/app/negezor/vk-io"><img src="https://img.shields.io/codacy/grade/25ee36d46e6e498981a74f8b0653aacc.svg?style=flat-square" alt="Code quality"></a>
 
-VK-IO Scenes - Simple implementation of middleware-based scene management 🎬
+> VK-IO Scenes - Simple implementation of middleware-based scene management 🎬
 
-## Installation
-> **[Node.js](https://nodejs.org/) 12.20.0 or newer is required** 
+## 📦 Installation
 
-### Yarn
-Recommended
-```
-yarn add @vk-io/scenes
-```
+> **[Node.js](https://nodejs.org/) 12.20.0 or newer is required**
 
-### NPM
-```
-npm i @vk-io/scenes
-```
+- **Using `Yarn`** (recommended)
+  ```shell
+  yarn add @vk-io/scenes
+  ```
+- **Using `npm`**
+  ```shell
+  npm i @vk-io/scenes
+  ```
+- **Using `pnpm`**
+  ```shell
+  pnpm add @vk-io/scenes
+  ```
 
 ## Example usage
-```js
+
+```javascript
 import { VK } from 'vk-io';
 
 // Session implementation can be any

diff --git a/packages/session/README.md b/packages/session/README.md
@@ -4,24 +4,27 @@
 <a href="https://www.npmjs.com/package/@vk-io/session"><img src="https://img.shields.io/npm/dt/@vk-io/session.svg?style=flat-square" alt="NPM downloads"></a>
 <a href="https://www.codacy.com/app/negezor/vk-io"><img src="https://img.shields.io/codacy/grade/25ee36d46e6e498981a74f8b0653aacc.svg?style=flat-square" alt="Code quality"></a>
 
-VK-IO Session - Simple implementation of the sessions ⚙️
+> VK-IO Session - Simple implementation of the sessions ⚙️
 
-## Installation
-> **[Node.js](https://nodejs.org/) 12.20.0 or newer is required** 
+## 📦 Installation
 
-### Yarn
-Recommended
-```
-yarn add @vk-io/session
-```
+> **[Node.js](https://nodejs.org/) 12.20.0 or newer is required**
 
-### NPM
-```
-npm i @vk-io/session
-```
+- **Using `Yarn`** (recommended)
+  ```shell
+  yarn add @vk-io/session
+  ```
+- **Using `npm`**
+  ```shell
+  npm i @vk-io/session
+  ```
+- **Using `pnpm`**
+  ```shell
+  pnpm add @vk-io/session
+  ```
 
 ## Example usage
-```js
+```javascript
 import { VK } from 'vk-io';
 
 import { SessionManager } from '@vk-io/session';

diff --git a/packages/stateless-prompt/README.md b/packages/stateless-prompt/README.md
@@ -1,33 +1,38 @@
-# VK-IO Stateless Prompt 
+# VK-IO Stateless Prompt
+
 <a href="https://www.npmjs.com/package/@vk-io/stateless-prompt"><img src="https://img.shields.io/npm/v/@vk-io/stateless-prompt.svg?style=flat-square" alt="NPM version"></a>
 <a href="https://github.com/negezor/vk-io/actions/workflows/tests.yml"><img src="https://img.shields.io/github/workflow/status/negezor/vk-io/VK-IO CI?style=flat-square" alt="Build Status"></a>
 <a href="https://www.npmjs.com/package/@vk-io/stateless-prompt"><img src="https://img.shields.io/npm/dt/@vk-io/stateless-prompt.svg?style=flat-square" alt="NPM downloads"></a>
 <a href="https://www.codacy.com/app/negezor/vk-io"><img src="https://img.shields.io/codacy/grade/25ee36d46e6e498981a74f8b0653aacc.svg?style=flat-square" alt="Code quality"></a>
 
-VK-IO Stateless Prompt - Simple implementation of middleware-based stateless prompt
+> VK-IO Stateless Prompt - Simple implementation of middleware-based stateless prompt
 
 ## How it works
 
 The basic concept is to send your message with a special text at the end. Then the user replies to the message, the bot checks message for a special text at the end of a reply message. If the message contains a special text, it calls a handler with a user message. If it doesn't contain a special text, then it skips. This is all!
 
 ![Example](https://user-images.githubusercontent.com/9392723/134985949-e5cf1758-0469-428e-85ed-12229e36e58b.png)
 
-## Installation
-> **[Node.js](https://nodejs.org/) 12.20.0 or newer is required** 
+## 📦 Installation
 
-### Yarn
-Recommended
-```
-yarn add @vk-io/stateless-prompt
-```
+> **[Node.js](https://nodejs.org/) 12.20.0 or newer is required**
 
-### NPM
-```
-npm i @vk-io/stateless-prompt
-```
+- **Using `Yarn`** (recommended)
+  ```shell
+  yarn add @vk-io/stateless-prompt
+  ```
+- **Using `npm`**
+  ```shell
+  npm i @vk-io/stateless-prompt
+  ```
+- **Using `pnpm`**
+  ```shell
+  pnpm add @vk-io/stateless-prompt
+  ```
 
 ## Example usage
-```js
+
+```javascript
 import { VK } from 'vk-io';
 
 import { StatelessPromptManager } from '@vk-io/stateless-prompt';

diff --git a/packages/streaming/README.md b/packages/streaming/README.md
@@ -4,24 +4,27 @@
 <a href="https://www.npmjs.com/package/@vk-io/streaming"><img src="https://img.shields.io/npm/dt/@vk-io/streaming.svg?style=flat-square" alt="NPM downloads"></a>
 <a href="https://www.codacy.com/app/negezor/vk-io"><img src="https://img.shields.io/codacy/grade/25ee36d46e6e498981a74f8b0653aacc.svg?style=flat-square" alt="Code quality"></a>
 
-VK-IO Streaming API - Separated module for receiving data with Streaming API ⚙️
+> VK-IO Streaming API - Separated module for receiving data with Streaming API ⚙️
 
-## Installation
-> **[Node.js](https://nodejs.org/) 12.20.0 or newer is required** 
+## 📦 Installation
 
-### Yarn
-Recommended
-```
-yarn add @vk-io/streaming
-```
+> **[Node.js](https://nodejs.org/) 12.20.0 or newer is required**
 
-### NPM
-```
-npm i @vk-io/streaming
-```
+- **Using `Yarn`** (recommended)
+  ```shell
+  yarn add @vk-io/streaming
+  ```
+- **Using `npm`**
+  ```shell
+  npm i @vk-io/streaming
+  ```
+- **Using `pnpm`**
+  ```shell
+  pnpm add @vk-io/streaming
+  ```
 
 ## Example usage
-```js
+```javascript
 import { VK } from 'vk-io';
 
 import { StreamingAPI } from '@vk-io/streaming';