Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Небольшие улучшения
  • Loading branch information
lentryd authored Aug 22, 2023
1 parent 86da851 commit 692e3d4
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
# NetSchoolApi

Это враппер для продукта "Сетевой город. Образование". С помощью которого вы можете получить информацию о пользователе (дневник, расписание и т.д.)
Это враппер для продукта "Сетевой город. Образование", который позволяет получать информацию о пользователе, такую как дневник, расписание и многое другое.

## Начало работы

Эти инструкции позволят вам запустить копию проекта на вашем локальном компьютере для целей разработки и тестирования.
Следующие инструкции помогут вам запустить проект на вашем локальном компьютере для разработки и тестирования.

### Предварительные условия

Чтобы установить библиотеку, вам необходимо:
Для установки и использования этой библиотеки вам понадобятся:

- NodeJS ≥ v10.24.1 ([установить](https://nodejs.org/ru/download/))

### Установка

Для установки необходимо ввести команду
Вы можете установить библиотеку с помощью следующей команды:

```bash
npm i netschoolapi
```

## Проверка установки

1. В корне проекта создайте файл `test.js`
2. В этот файл вставьте код ниже (введя ваши данные)
1. Создайте файл `test.js` в корне проекта.
2. Вставьте следующий код в файл `test.js`, заменив данные на ваши:

```javascript
const NS = require("netschoolapi").default;
Expand All @@ -40,35 +40,35 @@ const user = new NS({
})();
```

3. Запустите этот код введя в консоли команду
3. Запустите этот код в консоли с помощью следующей команды:

```bash
node test.js
```

4. Если в консоли не выводится информация о пользователе, то проверьте версию NodeJS или создайте [issue](https://github.com/lentryd/NetSchoolApi/issues/new)
4. Если в консоли не выводится информация о пользователе, убедитесь, что у вас установлена подходящая версия NodeJS, либо создайте [issue](https://github.com/lentryd/NetSchoolApi/issues/new) на GitHub.

## Информация о библиотеке
## Дополнительная информация о библиотеке

- [Доступные методы](./docs/guide.md)
- [Доступные классы](./docs/reference.md)

## Сделано с помощью
## Зависимости

- [ws](https://www.npmjs.com/package/ws) - Клиентская реализация WebSocket
- [node-fetch](https://www.npmjs.com/package/node-fetch) - Fetch API в Node.js
- [node-html-parser](https://www.npmjs.com/package/node-html-parser) - Генерация упрощенного DOM-дерева с поддержкой запросов к элементам.

## Управление версиями

Мы используем [SemVer](http://semver.org/) для управления версиями. Доступные версии см. в разделе [теги](https://github.com/lentryd/NetSchoolApi/tags).
Версии этой библиотеки управляются согласно [SemVer](http://semver.org/). Список доступных версий можно найти в разделе [теги](https://github.com/lentryd/NetSchoolApi/tags).

## Авторы

- [lentryd](https://github.com/lentryd)

Смотрите также список [участников](https://github.com/lentryd/NetSchoolApi/contributors), которые участвовали в этом проекте.
Также посмотрите список [участников](https://github.com/lentryd/NetSchoolApi/contributors), которые внесли свой вклад в проект.

## Лицензия

Этот проект лицензирован по лицензии MIT - см. [LICENSE](LICENSE) файл для получения подробной информации
Этот проект распространяется под лицензией MIT. Подробную информацию смотрите в файле [LICENSE](LICENSE).

0 comments on commit 692e3d4

Please sign in to comment.