Browse Source

chore: adds english documentation

e22m4u 1 year ago
parent
commit
10dbdbe926
3 changed files with 100 additions and 25 deletions
  1. 73 0
      README-ru.md
  2. 26 24
      README.md
  3. 1 1
      package.json

+ 73 - 0
README-ru.md

@@ -0,0 +1,73 @@
+## @e22m4u/js-path-trie
+
+*[English](./README.md) | Русский*
+
+Маршрутизатор на основе [префиксного дерева](https://ru.wikipedia.org/wiki/Trie) (trie).
+
+- Использует [path-to-regexp](https://github.com/pillarjs/path-to-regexp) синтаксис.
+- Поддерживает параметры маршрута.
+
+## Установка
+
+```bash
+npm install @e22m4u/js-path-trie
+```
+
+Для загрузки ES-модуля требуется установить `"type": "module"` в файле
+`package.json`, или использовать `.mjs` расширение.
+
+## Пример
+
+- `add(pathTemplate: string, value: unknown)` - добавить значение к новому маршруту
+- `match(path: string)` - поиск значения по заданному маршруту
+
+```js
+const trie = new PathTrie();
+
+// добавление маршрутов выполняется
+// методом "add", который принимает
+// шаблон маршрута и его значение
+trie.add('/foo/bar', yourValue1);
+trie.add('/foo/:p1/bar/:p2', yourValue2);
+
+// для поиска значения используется
+// метод "match", который возвращает
+// значение маршрута и его параметры
+trie.match('/foo/bar');
+// {
+//   value: yourValue1,
+//   params: {}
+// }
+
+// если маршрут имеет параметры,
+// то их значения вернуться
+// в результате поиска
+trie.match('/foo/10/bar/20');
+// {
+//   value: yourValue2,
+//   params: {p1: 10, p2: 20}
+// }
+
+// если маршрут не найден,
+// то возвращается "undefined"
+trie.match('/foo/bar/baz');
+// undefined
+```
+
+## Отладка
+
+Установка переменной `DEBUG` перед командой запуска включает вывод логов.
+
+```bash
+DEBUG=jsPathTrie* npm run test
+```
+
+## Тестирование
+
+```bash
+npm run test
+```
+
+## Лицензия
+
+MIT

+ 26 - 24
README.md

@@ -1,71 +1,73 @@
 ## @e22m4u/js-path-trie
 
-ES-модуль маршрутизации на основе [префиксного дерева](https://ru.wikipedia.org/wiki/Trie).
+*English | [Русский](./README-ru.md)*
 
-- Использует [path-to-regexp](https://github.com/pillarjs/path-to-regexp) синтаксис.
-- Поддерживает параметры маршрута.
+A router based on a [prefix tree](https://en.wikipedia.org/wiki/Trie) (trie).
 
-## Установка
+- Uses [path-to-regexp](https://github.com/pillarjs/path-to-regexp) syntax.
+- Supports path parameters.
+
+## Installation
 
 ```bash
 npm install @e22m4u/js-path-trie
 ```
 
-Для загрузки ES-модуля требуется установить `"type": "module"` в файле
-`package.json`, или использовать `.mjs` расширение.
+To load the ES-module, you need to set `"type": "module"`
+in the `package.json` file, or use the `.mjs` extension.
 
-## Пример
+## Example
 
-- `add(pathTemplate: string, value: unknown)` - добавить значение к новому маршруту
-- `match(path: string)` - поиск значения по заданному маршруту
+- `add(pathTemplate: string, value: unknown)` adds a value to a new route
+- `match(path: string)` returns a value by a given path
 
 ```js
 const trie = new PathTrie();
 
-// добавление маршрутов выполняется
-// методом "add", который принимает
-// шаблон маршрута и его значение
+// route registration is performed using
+// the "add" method, which takes a route
+// template and its value
 trie.add('/foo/bar', yourValue1);
 trie.add('/foo/:p1/bar/:p2', yourValue2);
 
-// для поиска значения используется
-// метод "match", который возвращает
-// значение маршрута и его параметры
+// to search for a value use the "match"
+// method, which returns the route value
+// and its parameters
 trie.match('/foo/bar');
 // {
 //   value: yourValue1,
 //   params: {}
 // }
 
-// если маршрут имеет параметры,
-// то их значения вернуться
-// в результате поиска
+// if a route has parameters
+// their values will be returned
+// in the search result
 trie.match('/foo/10/bar/20');
 // {
 //   value: yourValue2,
 //   params: {p1: 10, p2: 20}
 // }
 
-// если маршрут не найден,
-// то возвращается "undefined"
+// if a route is not found
+// "undefined" is returned
 trie.match('/foo/bar/baz');
 // undefined
 ```
 
-## Отладка
+## Debugging
 
-Установка переменной `DEBUG` перед командой запуска включает вывод логов.
+Set the `DEBUG` variable before the run command to enable log output.
 
 ```bash
 DEBUG=jsPathTrie* npm run test
 ```
 
-## Тестирование
+## Testing
 
 ```bash
 npm run test
 ```
 
-## Лицензия
+## License
 
 MIT

+ 1 - 1
package.json

@@ -1,7 +1,7 @@
 {
   "name": "@e22m4u/js-path-trie",
   "version": "0.0.2",
-  "description": "Маршрутизатор на основе префиксного дерева",
+  "description": "A router based on a prefix tree (trie).",
   "type": "module",
   "main": "src/index.js",
   "scripts": {