-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
23 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
version: 1 | ||
builder: | ||
configs: | ||
- documentation_targets: [Ngrokit, Sublimation, SublimationVapor] | ||
- documentation_targets: [Ngrokit] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,8 @@ | ||
# Ngrokit | ||
|
||
Swift API for Ngrok Agent API. | ||
Swift API for [Ngrok Agent API](https://ngrok.com/docs/agent/api/). | ||
|
||
[![](https://img.shields.io/badge/docc-read_documentation-blue)](https://swiftpackageindex.com/brightdigit/Ngrokit/documentation) | ||
[![SwiftPM](https://img.shields.io/badge/SPM-Linux%20%7C%20iOS%20%7C%20macOS%20%7C%20watchOS%20%7C%20tvOS-success?logo=swift)](https://swift.org) | ||
[![Twitter](https://img.shields.io/badge/[email protected]?style=flat)](http://twitter.com/brightdigit) | ||
![GitHub](https://img.shields.io/github/license/brightdigit/Ngrokit) | ||
|
@@ -17,7 +18,6 @@ Swift API for Ngrok Agent API. | |
[![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/brightdigit/Ngrokit)](https://codeclimate.com/github/brightdigit/Ngrokit) | ||
[![Code Climate technical debt](https://img.shields.io/codeclimate/tech-debt/brightdigit/Ngrokit?label=debt)](https://codeclimate.com/github/brightdigit/Ngrokit) | ||
[![Code Climate issues](https://img.shields.io/codeclimate/issues/brightdigit/Ngrokit)](https://codeclimate.com/github/brightdigit/Ngrokit) | ||
[![Reviewed by Hound](https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg)](https://houndci.com) | ||
|
||
# Table of Contents | ||
|
||
|
@@ -26,6 +26,7 @@ Swift API for Ngrok Agent API. | |
* [Usage](#usage) | ||
* [Connecting to the Local REST API](#connecting-to-the-local-rest-api) | ||
* [Starting the CLI Process](#starting-the-cli-process) | ||
* [Documentation](#documentation) | ||
* [License](#license) | ||
|
||
<!-- Created by https://github.com/ekalinin/github-markdown-toc --> | ||
|
@@ -70,7 +71,7 @@ Ngrokit is an easy to use Swift library for call the local Ngrok API as well as | |
|
||
### Connecting to the Local REST API | ||
|
||
Using the ``NgrokClient`` to connect to your local development server: | ||
Using the `NgrokClient` to connect to your local development server: | ||
|
||
```swift | ||
let client = NgrokClient(transport: URLSession.shared) | ||
|
@@ -80,7 +81,7 @@ For using different transports see the client list at the [Swift OpenAPI Generat | |
|
||
### Starting the CLI Process | ||
|
||
Start the CLI process by using ``NgrokProcessCLIAPI``: | ||
Start the CLI process by using `NgrokProcessCLIAPI`: | ||
|
||
```swift | ||
let cliAPI = NgrokProcessCLIAPI(ngrokPath: "/usr/local/bin/ngrok") | ||
|
@@ -89,6 +90,11 @@ process.run { let error in | |
print(error) | ||
} | ||
``` | ||
|
||
## Documentation | ||
|
||
To learn more, check out the full [documentation](https://swiftpackageindex.com/brightdigit/Ngrokit/documentation). | ||
|
||
# License | ||
|
||
This code is distributed under the MIT license. See the [LICENSE](https://github.com/brightdigit/Ngrokit/LICENSE) file for more info. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters