docs: обновить описание проекта (#101)

This commit is contained in:
Alexander Osadchy
2025-01-10 18:34:10 +04:00
parent bbc7c73264
commit e93d3be967
+57 -6
View File
@@ -7,20 +7,24 @@
<a href="https://github.com/alei1180/curlone/releases"><img alt="GitHub All Releases" src="https://img.shields.io/github/downloads/alei1180/curlone/total?style=flat-square"></a>
</p>
### Назначение
## Назначение
`curlone` - конвертер команды `curl` в код на языке `1С`.
### Сайт
## Сайт
[curlone.ru](http://curlone.ru/)
### Установка
## Установка
* [Скачать](https://github.com/alei1180/curlone/releases/latest) `curlone.ospx`
* Установить командой `opm install curlone.ospx`
### Запуск web приложения
## Использование
### web приложение
Запуск приложения:
```shell
curlone web -op 3333
@@ -29,10 +33,55 @@ curlone web -op 3333
* `o` - открыть в браузере
* `p` - порт, на котором будет запущено приложение
### Особенности использования
Пример конвертации:
>Команда curl
>
>```shell
>curl http://example.com/api --request POST -d "key=value" -H "X-Header: value"
>```
>
>Код 1C
>
>```bsl
>Заголовки = Новый Соответствие();
>Заголовки.Вставить("X-Header", "value");
>Заголовки.Вставить("Content-Type", "application/x-www-form-urlencoded");
>
>Соединение = Новый HTTPСоединение("example.com", 80);
>HTTPЗапрос = Новый HTTPЗапрос("/api", Заголовки);
>HTTPЗапрос.УстановитьТелоИзСтроки("key=value");
>
>HTTPОтвет = Соединение.ВызватьHTTPМетод("POST", HTTPЗапрос);
>```
### cli приложение
Синтаксис команды:
```shell
curlone convert <команда>
```
Пример команды:
>Оригинальная команда curl
>
>```shell
>curl http://example.com/api --request POST -d "key=value" -H "X-Header: value"
>```
>
>Команда curlone
>
>```shell
>curlone convert http://example.com/api --request POST -d "key=value" -H "X-Header: value"
>```
## Особенности использования
Команда `curl` указывается в нотации `bash`
### Благодарности
## Благодарности
Сообществу за свободные инструмены:
@@ -43,3 +92,5 @@ curlone web -op 3333
* [cli](https://github.com/oscript-library/cli)
* [1connector](https://github.com/vbondarevsky/1connector)
* [tokenizer](https://github.com/Nivanchenko/tokenizer)
* [coloratos](https://github.com/240596448/coloratos)
* [Shiki 式](hhttps://github.com/shikijs/shiki)