Skip to content

Commit

Permalink
last fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
leogdion committed Aug 27, 2024
1 parent 4c3d0f8 commit 7d5504b
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 17 deletions.
2 changes: 1 addition & 1 deletion .spi.yml
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]
20 changes: 10 additions & 10 deletions Package.swift
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// swift-tools-version: 5.9
// swift-tools-version: 6.0

import PackageDescription

Expand All @@ -15,16 +15,16 @@ let swiftSettings: [SwiftSetting] = [
SwiftSetting.enableExperimentalFeature("VariadicGenerics"),

SwiftSetting.enableUpcomingFeature("FullTypedThrows"),
SwiftSetting.enableUpcomingFeature("InternalImportsByDefault"),
SwiftSetting.enableUpcomingFeature("InternalImportsByDefault")

SwiftSetting.unsafeFlags([
"-Xfrontend",
"-warn-long-function-bodies=100"
]),
SwiftSetting.unsafeFlags([
"-Xfrontend",
"-warn-long-expression-type-checking=100"
])
// SwiftSetting.unsafeFlags([
// "-Xfrontend",
// "-warn-long-function-bodies=100"
// ]),
// SwiftSetting.unsafeFlags([
// "-Xfrontend",
// "-warn-long-expression-type-checking=100"
// ])
]

let package = Package(
Expand Down
14 changes: 10 additions & 4 deletions README.md
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)
Expand All @@ -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

Expand All @@ -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 -->
Expand Down Expand Up @@ -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)
Expand All @@ -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")
Expand All @@ -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.
4 changes: 2 additions & 2 deletions Sources/Ngrokit/Documentation.docc/Documentation.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# ``Ngrokit``

Swift API for Ngrok's Local API.
Swift API for [Ngrok Agent API](https://ngrok.com/docs/agent/api/).

## Overview

Ngrokit is an easy to use Swift library for call the local Ngrok API as well as running the `ngrok` command.
Ngrokit is an easy to use Swift library for call the Swift API for [Ngrok Agent API](https://ngrok.com/docs/agent/api/) as well as running the `ngrok` command.

### Connecting to the Local REST API

Expand Down

0 comments on commit 7d5504b

Please sign in to comment.