Browse Source

chore: updates readme

e22m4u 1 year ago
parent
commit
b1ca99c654
2 changed files with 6 additions and 10 deletions
  1. 3 5
      README-ru.md
  2. 3 5
      README.md

+ 3 - 5
README-ru.md

@@ -68,8 +68,6 @@ console.log(format(`A boolean required, but %v given.`, 'Oct 18 2024 13:04:30'))
 npm install @e22m4u/js-format
 npm install @e22m4u/js-format
 ```
 ```
 
 
-## Обзор
-
 Модуль поддерживает ESM и CommonJS стандарты.
 Модуль поддерживает ESM и CommonJS стандарты.
 
 
 *ESM*
 *ESM*
@@ -84,7 +82,7 @@ import {format} from '@e22m4u/js-format';
 const {format} = require('@e22m4u/js-format');
 const {format} = require('@e22m4u/js-format');
 ```
 ```
 
 
-### Спецификаторы
+## Спецификаторы
 
 
 Метод `format` возвращает отформатированную строку, используя
 Метод `format` возвращает отформатированную строку, используя
 первый аргумент как *printf*-подобный шаблон, который может
 первый аргумент как *printf*-подобный шаблон, который может
@@ -100,7 +98,7 @@ const {format} = require('@e22m4u/js-format');
 | `%v`      | см. ниже                                     |
 | `%v`      | см. ниже                                     |
 | `%l`      | см. ниже                                     |
 | `%l`      | см. ниже                                     |
 
 
-#### %v
+### %v
 
 
 Строки оборачиваются в кавычки, остальные примитивы приводятся
 Строки оборачиваются в кавычки, остальные примитивы приводятся
 к строке, а для более сложных типов выводится имя конструктора.
 к строке, а для более сложных типов выводится имя конструктора.
@@ -136,7 +134,7 @@ format('It is %v', MyClass);       // It is MyClass
 format('It is %v', new MyClass()); // It is MyClass (instance)
 format('It is %v', new MyClass()); // It is MyClass (instance)
 ```
 ```
 
 
-#### %l
+### %l
 
 
 Вывод элементов массива через запятую.
 Вывод элементов массива через запятую.
 
 

+ 3 - 5
README.md

@@ -68,8 +68,6 @@ see the [Specifiers](#Specifiers) section.
 npm install @e22m4u/js-format
 npm install @e22m4u/js-format
 ```
 ```
 
 
-## Overview
-
 The module supports ESM and CommonJS standards.
 The module supports ESM and CommonJS standards.
 
 
 *ESM*
 *ESM*
@@ -84,7 +82,7 @@ import {format} from '@e22m4u/js-format';
 const {format} = require('@e22m4u/js-format');
 const {format} = require('@e22m4u/js-format');
 ```
 ```
 
 
-### Specifiers
+## Specifiers
 
 
 The `format` method returns a formatted string using
 The `format` method returns a formatted string using
 the first argument as a printf-like template which can
 the first argument as a printf-like template which can
@@ -100,7 +98,7 @@ argument.
 | `%v`      | see below                                |
 | `%v`      | see below                                |
 | `%l`      | see below                                |
 | `%l`      | see below                                |
 
 
-#### %v
+### %v
 
 
 Strings are wrapped in quotes, other primitives are converted
 Strings are wrapped in quotes, other primitives are converted
 to strings, and for more complex types the constructor name
 to strings, and for more complex types the constructor name
@@ -137,7 +135,7 @@ format('It is %v', MyClass);       // It is MyClass
 format('It is %v', new MyClass()); // It is MyClass (instance)
 format('It is %v', new MyClass()); // It is MyClass (instance)
 ```
 ```
 
 
-#### %l
+### %l
 
 
 Outputs array elements separated by commas.
 Outputs array elements separated by commas.