README

shmily
Commit 78b7ae284881876873391b9a5766849e1f10dcd0 78b7ae28 1 parent 17888491
Showing 2 changed files with 255 additions and 27 deletions
README.md
gh-md-toc
--- a/README.md
View file @78b7ae2
+++ b/README.md
View file @78b7ae2
@@ -7,26 +7,26 @@
 </p>
    * [HHDoctorSDK 接入说明](#hhdoctorsdk-接入说明)
-      * [1. 概要介绍](#1-概要介绍)
-      * [2. 集成方式](#2-集成方式)
-         * [2.1. 手动集成](#21-手动集成)
-         * [2.2. 自动集成](#22-自动集成)
-         * [2.3. 调用规则](#23-调用规则)
-      * [3. 初始化](#3-初始化)
-      * [4. 登录账户](#4-登录账户)
-         * [4.1. 登录](#41-登录)
-         * [4.2. 登出](#42-登出)
-      * [5. 视频呼叫](#5-视频呼叫)
-      * [6. 代理(delegate)(可选)](#6-代理delegate可选)
-         * [6.1. 加入](#61-加入)
-         * [6.2. 移除](#62-移除)
+      * [1. 集成方式](#1-集成方式)
+         * [1.1. 手动集成](#11-手动集成)
+         * [1.2. 自动集成](#12-自动集成)
+         * [1.3. 调用规则](#13-调用规则)
+      * [2. 初始化](#2-初始化)
+      * [3. 登录账户](#3-登录账户)
+         * [3.1. 登录](#31-登录)
+         * [3.2. 登出](#32-登出)
+      * [4. 视频呼叫](#4-视频呼叫)
+      * [5. 代理(delegate)(可选)](#5-代理delegate可选)
+         * [5.1. 加入](#51-加入)
+         * [5.2. 移除](#52-移除)
-## 1.概要介绍
-## 2.集成方式
+
+## 1. 集成方式
  HHDoctorSDK 提供两种集成方式：您既可以通过 CocoaPods 自动集成我们的 SDK，也可以通过手动下载 SDK, 然后添加到您的项目中。
 我们提供的下载地址：
- 我们提供了发布仓库 [HHDoctorSDK](https://code.hh-medic.com/hh_public/HHDoctorSDK.ios)。
+ 我们提供了发布仓库: [HHDoctorSDK](https://code.hh-medic.com/hh_public/HHDoctorSDK.ios)。
+ 集成demo地址: [HHDoctorSDK_demo_iOS](https://github.com/HHMedic/HHDoctorSDK_demo_iOS)
 由于呼叫视频需要相机相册权限，需要在info.plist中添加对应的权限，否则会导致无法调用。
@@ -39,7 +39,7 @@
 <string>应用需使用麦克风权限，以便您向医生进行视频咨询。</string>
 ```
-### 2.1.手动集成
+### 1.1. 手动集成
 1. 根据自己工程需要，下载对应版本的 HHMSDK，得到 NIMSDK.framework ，NIMAVChat.framework，NVS.framework，SecurityKit.framework 和 HHDoctorSDK.framework，以及未链接的全部三方依赖库 ，将他们导入工程。
 2. 添加其他 HHDoctorSDK 依赖库。
@@ -58,7 +58,7 @@
 4. 在 `Build Settings` -> `Enable Bitcode 里，设置为 `No`。
 5. 如果需要在后台时保持音频通话状态，在 `Capabilities` -> `Background Modes` 里勾选 `audio, airplay, and Picture in Picture`。
-### 2.2.自动集成
+### 1.2. 自动集成
 * 在 `Podfile` 文件中加入
 ```shell
@@ -71,7 +71,7 @@ pod 'HHDoctorSDK', :git => "git@code.hh-medic.com:hh_public/HHDoctorSDK.ios.git"
 pod install
 ```
-### 2.3.调用规则
+### 1.3. 调用规则
 所有 HHDoctorSDK 业务均通过 HHMSDK 单例调用
 ```swift
@@ -81,7 +81,7 @@ public class HHMSDK : NSObject {
 }
 ```
-## 3.初始化
+## 2. 初始化
 在使用 HHDoctorSDK 任何方法之前，都应该首先调用初始化方法。正常业务情况下，初始化方法有仅只应调用一次。
 HHSDKOptions 选项参数列表
@@ -104,9 +104,9 @@ let option = HHSDKOptions(isDebug: true, isDevelop: true)
 HHMSDK.default.start(option: option)
 ```
-## 4. 登录账户
+## 3. 登录账户
 在对医生视频呼叫之前，需要先登录账号信息。账号的 uuid 由和缓提供。
-### 4.1. 登录
+### 3.1. 登录
 * 原型
@@ -134,7 +134,7 @@ HHMSDK.default.login(uuid: 100001531) { (error) in
 ```
 error 为登录错误信息，成功则为 nil。
-### 4.2. 登出
+### 3.2. 登出
 应用层登出/注销/切换自己的账号时需要调用 HHMSDK 的登出操作，该操作会通知和缓服务器进行 APNs 推送信息的解绑操作，避免用户已登出但推送依然发送到当前设备的情况发生。
 * 原型
@@ -154,7 +154,7 @@ public class HHMSDK : NSObject {
 HHMSDK.default.logout()
 ```
-## 5. 视频呼叫
+## 4. 视频呼叫
 根据实际场景的不同，可以进行成人、儿童方向的向医生咨询。
 * 原型
@@ -186,7 +186,7 @@ HHCallType 枚举列表
 child | 儿童
 adult | 成人
-## 6. 代理(delegate)(可选)
+## 5. 代理(delegate)(可选)
 代理主要用于视频过程中的状态反馈。如果不需要状态反馈，可以不考虑该代理。
 所有的代理方法都是可选的，可以根据自己的实际需要实现不同的代理方法。
@@ -234,14 +234,14 @@ public protocol HHMVideoDelegate : NSObjectProtocol {
 }
 ```
-### 6.1. 加入
+### 5.1. 加入
 代理支持同时设置多个。
 ```swift
 HHMSDK.default.add(delegate: self)
 ```
-### 6.2. 移除
+### 5.2. 移除
 ```swift
 HHMSDK.default.remove(delegate: self)
--- a/gh-md-toc 0 → 100755
View file @78b7ae2
+++ b/gh-md-toc 0 → 100755
View file @78b7ae2
+#!/usr/bin/env bash
+
+#
+# Steps:
+#
+#  1. Download corresponding html file for some README.md:
+#       curl -s $1
+#
+#  2. Discard rows where no substring 'user-content-' (github's markup):
+#       awk '/user-content-/ { ...
+#
+#  3.1 Get last number in each row like ' ... </span></a>sitemap.js</h1'.
+#      It's a level of the current header:
+#       substr($0, length($0), 1)
+#
+#  3.2 Get level from 3.1 and insert corresponding number of spaces before '*':
+#       sprintf("%*s", substr($0, length($0), 1)*3, " ")
+#
+#  4. Find head's text and insert it inside "* [ ... ]":
+#       substr($0, match($0, /a>.*<\/h/)+2, RLENGTH-5)
+#
+#  5. Find anchor and insert it inside "(...)":
+#       substr($0, match($0, "href=\"[^\"]+?\" ")+6, RLENGTH-8)
+#
+
+gh_toc_version="0.5.0"
+
+gh_user_agent="gh-md-toc v$gh_toc_version"
+
+#
+# Download rendered into html README.md by its url.
+#
+#
+gh_toc_load() {
+    local gh_url=$1
+
+    if type curl &>/dev/null; then
+        curl --user-agent "$gh_user_agent" -s "$gh_url"
+    elif type wget &>/dev/null; then
+        wget --user-agent="$gh_user_agent" -qO- "$gh_url"
+    else
+        echo "Please, install 'curl' or 'wget' and try again."
+        exit 1
+    fi
+}
+
+#
+# Converts local md file into html by GitHub
+#
+# ➥ curl -X POST --data '{"text": "Hello world github/linguist#1 **cool**, and #1!"}' https://api.github.com/markdown
+# <p>Hello world github/linguist#1 <strong>cool</strong>, and #1!</p>'"
+gh_toc_md2html() {
+    local gh_file_md=$1
+    URL=https://api.github.com/markdown/raw
+    TOKEN="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/token.txt"
+    if [ -f "$TOKEN" ]; then
+        URL="$URL?access_token=$(cat $TOKEN)"
+    fi
+    curl -s --user-agent "$gh_user_agent" \
+        --data-binary @"$gh_file_md" -H "Content-Type:text/plain" \
+        $URL
+}
+
+#
+# Is passed string url
+#
+gh_is_url() {
+    case $1 in
+        https* | http*)
+            echo "yes";;
+        *)
+            echo "no";;
+    esac
+}
+
+#
+# TOC generator
+#
+gh_toc(){
+    local gh_src=$1
+    local gh_src_copy=$1
+    local gh_ttl_docs=$2
+    local need_replace=$3
+
+    if [ "$gh_src" = "" ]; then
+        echo "Please, enter URL or local path for a README.md"
+        exit 1
+    fi
+
+
+    # Show "TOC" string only if working with one document
+    if [ "$gh_ttl_docs" = "1" ]; then
+
+        echo "Table of Contents"
+        echo "================="
+        echo ""
+        gh_src_copy=""
+
+    fi
+
+    if [ "$(gh_is_url "$gh_src")" == "yes" ]; then
+        gh_toc_load "$gh_src" | gh_toc_grab "$gh_src_copy"
+        if [ "$need_replace" = "yes" ]; then
+            echo
+            echo "!! '$gh_src' is not a local file"
+            echo "!! Can't insert the TOC into it."
+            echo
+        fi
+    else
+        local toc=`gh_toc_md2html "$gh_src" | gh_toc_grab "$gh_src_copy"`
+        echo "$toc"
+        if [ "$need_replace" = "yes" ]; then
+            local ts="<\!--ts-->"
+            local te="<\!--te-->"
+            local dt=`date +'%F_%H%M%S'`
+            local ext=".orig.${dt}"
+            local toc_path="${gh_src}.toc.${dt}"
+            local toc_footer="<!-- Added by: `whoami`, at: `date --iso-8601='minutes'` -->"
+            # http://fahdshariff.blogspot.ru/2012/12/sed-mutli-line-replacement-between-two.html
+            # clear old TOC
+            sed -i${ext} "/${ts}/,/${te}/{//!d;}" "$gh_src"
+            # create toc file
+            echo "${toc}" > "${toc_path}"
+            echo -e "\n${toc_footer}\n" >> "$toc_path"
+            # insert toc file
+            if [[ "`uname`" == "Darwin" ]]; then
+                sed -i "" "/${ts}/r ${toc_path}" "$gh_src"
+            else
+                sed -i "/${ts}/r ${toc_path}" "$gh_src"
+            fi
+            echo
+            echo "!! TOC was added into: '$gh_src'"
+            echo "!! Origin version of the file: '${gh_src}${ext}'"
+            echo "!! TOC added into a separate file: '${toc_path}'"
+            echo
+        fi
+    fi
+}
+
+#
+# Grabber of the TOC from rendered html
+#
+# $1 — a source url of document.
+# It's need if TOC is generated for multiple documents.
+#
+gh_toc_grab() {
+	# if closed <h[1-6]> is on the new line, then move it on the prev line
+	# for example:
+	# 	was: The command <code>foo1</code>
+	# 		 </h1>
+	# 	became: The command <code>foo1</code></h1>
+    sed -e ':a' -e 'N' -e '$!ba' -e 's/\n<\/h/<\/h/g' |
+    # find strings that corresponds to template
+    grep -E -o '<a.*id="user-content-[^"]*".*</h[1-6]' |
+    # remove code tags
+    sed 's/<code>//' | sed 's/<\/code>//' |
+    # now all rows are like:
+    #   <a id="user-content-..." href="..."><span ...></span></a> ... </h1
+    # format result line
+    #   * $0 — whole string
+    echo -e "$(awk -v "gh_url=$1" '{
+    print sprintf("%*s", substr($0, length($0), 1)*3, " ") "* [" substr($0, match($0, /a>.*<\/h/)+2, RLENGTH-5)"](" gh_url substr($0, match($0, "href=\"[^\"]+?\" ")+6, RLENGTH-8) ")"}' | sed 'y/+/ /; s/%/\\x/g')"
+}
+
+#
+# Returns filename only from full path or url
+#
+gh_toc_get_filename() {
+    echo "${1##*/}"
+}
+
+#
+# Options hendlers
+#
+gh_toc_app() {
+    local app_name="gh-md-toc"
+    local need_replace="no"
+
+    if [ "$1" = '--help' ] || [ $# -eq 0 ] ; then
+        echo "GitHub TOC generator ($app_name): $gh_toc_version"
+        echo ""
+        echo "Usage:"
+        echo "  $app_name [--insert] src [src]  Create TOC for a README file (url or local path)"
+        echo "  $app_name -                     Create TOC for markdown from STDIN"
+        echo "  $app_name --help                Show help"
+        echo "  $app_name --version             Show version"
+        return
+    fi
+
+    if [ "$1" = '--version' ]; then
+        echo "$gh_toc_version"
+        return
+    fi
+
+    if [ "$1" = "-" ]; then
+        if [ -z "$TMPDIR" ]; then
+            TMPDIR="/tmp"
+        elif [ -n "$TMPDIR" -a ! -d "$TMPDIR" ]; then
+            mkdir -p "$TMPDIR"
+        fi
+        local gh_tmp_md
+        gh_tmp_md=$(mktemp $TMPDIR/tmp.XXXXXX)
+        while read input; do
+            echo "$input" >> "$gh_tmp_md"
+        done
+        gh_toc_md2html "$gh_tmp_md" | gh_toc_grab ""
+        return
+    fi
+
+    if [ "$1" = '--insert' ]; then
+        need_replace="yes"
+        shift
+    fi
+
+    for md in "$@"
+    do
+        echo ""
+        gh_toc "$md" "$#" "$need_replace"
+    done
+
+    echo ""
+    echo "Created by [gh-md-toc](https://github.com/ekalinin/github-markdown-toc)"
+}
+
+#
+# Entry point
+#
+gh_toc_app "$@"