Skip to content

Commit f112cb3

Browse files
committed
docs: english README
1 parent 4d7b2be commit f112cb3

File tree

3 files changed

+51
-48
lines changed

3 files changed

+51
-48
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,4 +84,7 @@ git push origin <name_of_your_new_branch>
8484
```
8585

8686
Затем откройте [pull request](https://github.com/SevereCloud/vksdk/pulls)
87-
с `master` веткой
87+
с веткой:
88+
89+
- `master` если это багфикс
90+
- `dev` если это новая фича

README.md

Lines changed: 46 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -8,57 +8,57 @@
88
[![release](https://img.shields.io/github/v/tag/SevereCloud/vksdk?label=release)](https://github.com/SevereCloud/vksdk/releases)
99
[![license](https://img.shields.io/github/license/SevereCloud/vksdk.svg?maxAge=2592000)](https://github.com/SevereCloud/vksdk/blob/master/LICENSE)
1010

11-
**VK SDK for Golang** готовая реализация основных функций VK API для языка Go.
12-
13-
[English documentation](https://pkg.go.dev/github.com/SevereCloud/vksdk)
14-
15-
## Возможности
16-
17-
- [API](https://github.com/SevereCloud/vksdk/tree/master/api#api)
18-
- Возвращает готовые структуры
19-
- Реализовано 400+ методов
20-
- Возможность изменять обработчик запросов
21-
- Возможность изменять HTTP клиент
22-
- Ограничитель запросов
23-
- Загрузка файлов
24-
- [Callback API](https://github.com/SevereCloud/vksdk/tree/master/callback#callback-api)
25-
- Поддерживает все события
26-
- Возвращает готовые структуры
27-
- [Bots Long Poll API](https://github.com/SevereCloud/vksdk/tree/master/longpoll-bot#bots-long-poll-api)
28-
- Поддерживает все события
29-
- Возвращает готовые структуры
30-
- Возможность изменять HTTP клиент
31-
- [User Long Poll API](https://github.com/SevereCloud/vksdk/tree/master/longpoll-user#user-long-poll-api)
32-
- Возвращает готовые структуры
33-
- Возможность изменять HTTP клиент
11+
**VK SDK for Golang** ready implementation of the main VK API functions for Go.
12+
13+
[Russian documentation](https://github.com/SevereCloud/vksdk/wiki)
14+
15+
## Features
16+
17+
- [API](https://pkg.go.dev/github.com/SevereCloud/vksdk/api)
18+
- 400+ methods
19+
- Ability to change the request handler
20+
- Ability to modify HTTP client
21+
- Request Limiter
22+
- Token pool
23+
- [Callback API](https://pkg.go.dev/github.com/SevereCloud/vksdk/callback)
24+
- Tracking tool for users activity in your VK communities
25+
- Supports all events
26+
- Auto setting callback
27+
- [Bots Long Poll API](https://pkg.go.dev/github.com/SevereCloud/vksdk/longpoll-bot)
28+
- Allows you to work with community events in real time
29+
- Supports all events
30+
- Ability to modify HTTP client
31+
- [User Long Poll API](https://pkg.go.dev/github.com/SevereCloud/vksdk/longpoll-user)
32+
- Allows you to work with user events in real time
33+
- Ability to modify HTTP client
3434
- [Streaming API](https://pkg.go.dev/github.com/SevereCloud/vksdk/streaming)
35-
- Возвращает готовые структуры
36-
- Возможность изменять HTTP клиент
37-
- [FOAF](https://github.com/SevereCloud/vksdk/tree/master/foaf#foaf)
38-
- Работает с пользователями и группами
39-
- Возвращает готовые структуры
40-
- [VK Mini Apps](https://github.com/SevereCloud/vksdk/tree/master/vkapps#vk-mini-apps)
41-
- Проверка параметров запуска
42-
- Промежуточный http обработчик
35+
- Receiving public data from VK by specified keywords
36+
- Ability to modify HTTP client
37+
- [FOAF](https://pkg.go.dev/github.com/SevereCloud/vksdk/foaf)
38+
- Machine-readable ontology describing persons
39+
- Works with users and groups
40+
- The only place to get page creation date
41+
- [VK Mini Apps](https://pkg.go.dev/github.com/SevereCloud/vksdk/vkapps)
42+
- Checking launch parameters
43+
- Intermediate http handler
4344
- [Payments API](https://pkg.go.dev/github.com/SevereCloud/vksdk/payments)
44-
- Обрабатывает уведомления о платежах
45-
- [Скиллы Маруси](https://pkg.go.dev/github.com/SevereCloud/vksdk/marusia)
46-
- Готовые структуры и методы
47-
- Обработка запросов от Маруси
45+
- Processes payment notifications
46+
- [Marusia Skills](https://pkg.go.dev/github.com/SevereCloud/vksdk/marusia)
47+
- For creating Marusia Skills
4848

49-
## Установка
49+
## Install
5050

51-
```shell
51+
```bash
5252
# go mod init mymodulename
5353
go get github.com/SevereCloud/vksdk@latest
5454
```
5555

56-
## Примеры использования
56+
## Use by
5757

58-
- [Joe](https://github.com/go-joe/joe) адаптер: <https://github.com/tdakkota/joe-vk-adapter>
58+
- [Joe](https://github.com/go-joe/joe) adapter: <https://github.com/tdakkota/joe-vk-adapter>
5959
- [Logrus](https://github.com/sirupsen/logrus) hook: <https://github.com/SevereCloud/vkrus>
6060

61-
### Пример
61+
### Example
6262

6363
```go
6464
package main
@@ -73,22 +73,22 @@ import (
7373
)
7474

7575
func main() {
76-
token := "<TOKEN>" // рекомендуется использовать os.Getenv("TOKEN")
76+
token := "<TOKEN>" // use os.Getenv("TOKEN")
7777
vk := api.NewVK(token)
7878

79-
// Получаем информацию о группе
79+
// get information about the group
8080
group, err := vk.GroupsGetByID(nil)
8181
if err != nil {
8282
log.Fatal(err)
8383
}
8484

85-
// Инициализируем Long Poll
85+
// Initializing Long Poll
8686
lp, err := longpoll.NewLongPoll(vk, group[0].ID)
8787
if err != nil {
8888
log.Fatal(err)
8989
}
9090

91-
// Событие нового сообщения
91+
// New message event
9292
lp.MessageNew(func(obj object.MessageNewObject, groupID int) {
9393
log.Printf("%d: %s", obj.Message.PeerID, obj.Message.Text)
9494

@@ -105,14 +105,14 @@ func main() {
105105
}
106106
})
107107

108-
// Запускаем Bots Long Poll
108+
// Run Bots Long Poll
109109
log.Println("Start Long Poll")
110110
if err := lp.Run(); err != nil {
111111
log.Fatal(err)
112112
}
113113
}
114114
```
115115

116-
## Лицензия
116+
## LICENSE
117117

118118
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FSevereCloud%2Fvksdk.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2FSevereCloud%2Fvksdk?ref=badge_large)

marusia/skill.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Package marusia для создания скилла Маруси.
66
а разработчики и владельцы бизнеса смогут сделать голосовой интерфейс для
77
своих продуктов.
88
9-
Документация: https://vk.com/dev/marusia_skill
9+
Документация: https://vk.com/dev/marusia_skill_docs
1010
1111
Регистрация приложения ВКонтакте
1212

0 commit comments

Comments
 (0)