[ADD] readme file

hinagawa · May 20, 2021 · 9950ca7 · 9950ca7
1 parent 969f234
commit 9950ca7
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/iterator/README.md b/iterator/README.md
@@ -0,0 +1,18 @@
+## Реализация итератора на TypeScript (Frontend)
+
+**У итератора есть опция пропускать маленькие города**
+
+```javascript
+const iteratorWithNoSkip = new CityIterator(citiesList, false);
+
+const iteratorWithSkip = new CityIterator(citiesList, true);
+```
+### Шаги для инициализации
+- Перейти в папку `iterator`
+- Установить dev-зависимости `npm install`
+
+### Проверка в браузере
+- Выполнить npm start
+
+### Запуск тестов
+- Выполнить npm test