chore: improve README #25
Merged
Conversation
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
Contributor
fortuna
commented
Jun 26, 2023
fortuna
commented
- Add information on how to integrate
- Clean up plan information
- Add image
jyyi1
reviewed
Jun 26, 2023
README.md
Outdated
|
|
||
| | Multi-Platform | Proven Technology | Composable | | ||
| |-|-|-| | ||
| | The Outline SDK can be used on Android, iOS, Windows, macOS or Linux. | The Outline Client and Server have been using the SDK for years, helping millions of users in the harshest conditions. | The SDK interfaces were carefully designed to allow for composition and reuse, so you can craft your own transport. | |
There was a problem hiding this comment.
... have been using the SDK for years ...
Are we gonna really mention "for years" here 😄 ? Because the SDK repository has only been created less than one year.
There was a problem hiding this comment.
I updated to "The Outline Client and Server have been using the code in the SDK for years" to be clear it's the code, not the SDK
README.md
Outdated
|
|
||
| The Outline SDK is written in Go. There are multiple ways to integrate the Outline SDK into your app: | ||
|
|
||
| - As a **Go library**, in a Go application (CLI or graphical app with frameworks like [Fyne.io](https://fyne.io/), [Wails](https://wails.io/), [Qt for Go](https://therecipe.github.io/qt/), or [Go Mobile app](https://pkg.go.dev/golang.org/x/mobile/app) |
There was a problem hiding this comment.
The Go GUI frameworks doesn't seem to be related to our SDK. Do we need to mention them here?
There was a problem hiding this comment.
People don't know how to do graphical apps in Go, so it's helpful to let them know about some possibilities.
Writing an app on those platforms may be easier than the other integration options.
Co-authored-by: J. Yi <[email protected]>
jyyi1
approved these changes
Jun 26, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.