Merge branch 'documentat'

2gis · Mar 21, 2021 · 22c8261 · 22c8261
2 parents cd28bea + fb129b1
commit 22c8261
Show file tree

Hide file tree

Showing 3 changed files with 75 additions and 34 deletions.
diff --git a/README.md b/README.md
@@ -1,33 +1,47 @@
-# 2GIS iOS NativeSDK Demo
+# 2GIS iOS Native SDK
 
-> ⚠️ 2GIS NativeSDK в процессе разработки. Не подготовлено к использованию в боевых приложениях.
+iOS Native SDK от 2GIS позволяет добавить [карту 2GIS](https://2gis.ru/) в ваше приложение под iOS. С его помощью вы можете отображать карту на экране, добавлять на карту пользовательские маркеры, а также выделять на карте различные объекты, такие как здания, дороги и т. д.
 
-2GIS NativeSDK iOS Demo - это проект, демонстрирующий разработчику возможности использования нативного инструмента работы с картой от команды 2ГИС под iOS.
+> :warning: **2GIS iOS Native SDK в процессе разработки.** Не подготовлено к использованию в боевых приложениях.
 
-### Документация:
-Демо-проект не охватывает всех возможностей NativeSDK. Для более детального анализа и проработки необходимо обратиться к [официальной документации](https://docs-canary.2gis.com/ru/ios/native/maps/reference/Container).
+## Получение ключа доступа
 
-### Минимальные требования:
+Чтобы использовать этот SDK, необходим ключ API для подключения к серверам 2GIS и получения географических данных. Этот ключ доступа API уникален для конкретного SDK и не может быть использован с другими SDK от 2GIS.
+
+Кроме того, если вы планируете использовать справочник или прокладывать маршруты на карте, то вам понадобится отдельный ключ API.
+
+Чтобы получить любой из этих ключей API, заполните форму на [dev.2gis.ru](https://dev.2gis.ru/order).
+
+## Установка
+
+...
+
+Минимальные требования:
 - XCode 12;
-- Для того чтобы запусить проект через XCode достаточно использовать любой симулятор или девайс с операционными системами iOS 13.0+ или iPadOS 13.0+ (это обусловлено использованием в проекте [SwiftUI](https://developer.apple.com/documentation/swiftui)).
+- Симулятор или устройство с операционными системами iOS 13.0+ или iPadOS 13.0+ (это обусловлено использованием в проекте [SwiftUI](https://developer.apple.com/documentation/swiftui)).
+
+При необходимости можно использовать [xcframework](https://github.com/2gis/native-sdk-ios-swift-package/blob/master/Package.swift) для сборки собственного проекта под iOS 12.
+
+## Запуск демо-приложения
+
+Чтобы запустить демонстрационное приложение:
+1. Склонируйте этот репозиторий.
+2. Откройте проект `app.xcodeproj` и задайте ваши ключи API в файле `Info.plist` проекта:
+
+   ```
+   dgisMapApiKey=YOUR_MAP_KEY
+   dgisDirectoryApiKey=YOUR_DIRECTIONS_KEY
+   ```
+
+3. Дождитесь загрузки зависимостей Swift. Эта операция может занять длительное время.
 
-> **При необходимости можно использовать xcframework, расположенный по [ссылке](https://github.com/2gis/native-sdk-ios-swift-package/blob/master/Package.swift) для сборки собственного проекта под iOS 12**.
+   Вы не сможете собрать и запустить проект, пока не будут загружены зависимости.
+
+4. Соберите и запустите проект (⌘+R).
 
-### Установка:
-1. Склонировать проект любым удобным способом
- - через Терминал, используя команду 
-```bash 
-git clone https://github.com/2gis/native-sdk-ios-demo.git
-```
- - через SourceTree File -> New -> Clone with URL
- - любым другим удобным способом
-2. Запустить проект `app.xcodeprojxx в рутовой директории проекта.
-3. Выставить ключи `DGISDirectoryAPIKey` и `DGISMapAPIKey` в файле `Info.plist`.
 
-> Для получения ключей [напишите нам](https://dev.2gis.ru/order/).
+## Документация
 
-4. Дождаться подгрузки свифтовых зависимостей (необходимо иметь устойчивое интернет-соединение, т.к. zip-архив с xcframework весит 200+ МБ).
-5. <kbd>Cmd</kbd> + <kbd>R</kbd>
+Полная документация по SDK, включающая [примеры использования](https://docs.2gis.com/ru/ios/native/maps/examples) и [справочник API](https://docs.2gis.com/en/ios/native/maps/reference/Container) с детальным описанием всех классов и методов, расположена на [docs.2gis.com](https://docs.2gis.com/ru/ios/native/maps/overview).
 
-> ⚠️ В случае если зависимости не подгрузились, вы увидите уведомление **Build operations are disabled: Package loading in progress**. В таком случае нужно дождаться выполнения предыдущего пункта.
 
diff --git a/docs/ru/examples.md b/docs/ru/examples.md
@@ -1,5 +1,21 @@
-## Инициализации
+## Начало работы
 
+Для запуска примера:
+1. Склонируйте [GitHub-репозиторий 2GIS](https://github.com/2gis/native-sdk-ios-demo).
+2. Откройте проект `app.xcodeproj` и задайте ваши ключи API в файле `Info.plist` проекта:
+
+   ```
+   dgisMapApiKey=YOUR_MAP_KEY
+   dgisDirectoryApiKey=YOUR_DIRECTIONS_KEY
+   ```
+
+3. Дождитесь загрузки зависимостей Swift. Эта операция может занять длительное время.
+
+   Вы не сможете собрать и запустить проект, пока не будут загружены зависимости.
+
+4. Соберите и запустите проект (⌘+R).
+
+## Инициализация
 *// TODO: инициализация SDK, работа с ключами*
 
 ## Общая информация
@@ -150,7 +166,7 @@ let polyline = objectsManager.addPolyline(options: options)
 потому что уничтожение `Cancellable`-объекта приводит к немедленной отмене
 подписки на `Future<T>`.
 
-```
+```swift
 /// - Parameter point: A tap point in *pixel* (native scale) cooordinates.
 /// - Parameter tapRadius: Radius around tap point in which objects will
 ///   be detected.

diff --git a/docs/ru/overview.md b/docs/ru/overview.md
@@ -1,16 +1,27 @@
-# Overview
+# 2GIS iOS Native SDK
 
-## Introduction
-2GIS iOS NativeSDK is an SDK that allows you to add a 2GIS map to your iOS application. It can be used to display the map in your layout, add custom markers to it, and highlight various objects on the map, such as buildings, roads, and others.
+iOS Native SDK от 2GIS позволяет добавить [карту 2GIS](https://2gis.ru/) в ваше приложение под iOS. С его помощью вы можете отображать карту на экране, добавлять на карту пользовательские маркеры, а также выделять на карте различные объекты, такие как здания, дороги и т. д.
 
-## Getting an access key
-Usage of this SDK requires an API key to connect to 2GIS servers and retrieve the geographical data. This API key is unique to the SDK and cannot be used with other 2GIS SDKs.
+> :warning: **2GIS iOS Native SDK в процессе разработки.** Не подготовлено к использованию в боевых приложениях.
 
-To obtain the key, [contact us](https://dev.2gis.ru/order/).
+## Получение ключа доступа
 
-## Installation
-*// TBD*
+Чтобы использовать этот SDK, необходим ключ API для подключения к серверам 2GIS и получения географических данных. Этот ключ доступа API уникален для конкретного SDK и не может быть использован с другими SDK от 2GIS.
 
-### Минимальные требования:
+Кроме того, если вы планируете использовать справочник или прокладывать маршруты на карте, то вам понадобится отдельный ключ API.
+
+Чтобы получить любой из этих ключей API, заполните форму на [dev.2gis.ru](https://dev.2gis.ru/order).
+
+## Установка
+
+...
+
+Минимальные требования:
 - XCode 12;
-- Чтобы запустить демо-проект через XCode, необходимо использовать любой симулятор или устройство с iOS (iPadOS) 13.0+. Это обусловлено использованием в проекте [SwiftUI](https://developer.apple.com/documentation/swiftui).
+- Симулятор или устройство с операционными системами iOS 13.0+ или iPadOS 13.0+ (это обусловлено использованием в проекте [SwiftUI](https://developer.apple.com/documentation/swiftui)).
+
+При необходимости можно использовать [xcframework](https://github.com/2gis/native-sdk-ios-swift-package/blob/master/Package.swift) для сборки собственного проекта под iOS 12.
+
+После этого всё должно быть готово к работе. В разделе [Примеры](/ru/ios/native/maps/examples) вы можете посмотреть, как добавить карту к вашему приложению. Или загляните в [описание API](/en/ios/native/maps/reference/Container), чтобы узнать больше о конкретных классах и методах.
+
+Также доступен [GitHub-репозиторий](https://github.com/2gis/native-sdk-ios-demo/), в котором можно познакомиться с SDK и демонстрационным проектом.