Update Docs on GoMod and Go1.7 (#30)

* Update Docs on GoMod and Go1.7
This commit is contained in:
Eric Duncan 2020-02-12 00:56:44 -05:00 committed by GitHub
parent 71f0d6d1c6
commit 8139fb1eaf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 25 additions and 2 deletions

View File

@ -27,6 +27,15 @@ validation, overrides and duplicate setters through the feed.
Full detailed Examples of the API are at <a href="https://godoc.org/github.com/eduncan911/podcast">https://godoc.org/github.com/eduncan911/podcast</a>. Full detailed Examples of the API are at <a href="https://godoc.org/github.com/eduncan911/podcast">https://godoc.org/github.com/eduncan911/podcast</a>.
### Go Modules
This library is supported on GoLang 1.7 and higher.
We have implemented Go Modules support and the CI pipeline shows it working with
new installs, tested with Go 1.13. To keep 1.7 compatibility, we use
`go mod vendor` to maintain the `vendor/` folder for older 1.7 and later runtimes.
If either runtime has an issue, please create an Issue and I will address.
### Extensibility ### Extensibility
In no way are you restricted in having full control over your feeds. You may In no way are you restricted in having full control over your feeds. You may
choose to skip the API methods and instead use the structs directly. The choose to skip the API methods and instead use the structs directly. The
@ -63,8 +72,10 @@ bypass the API methods and use the underlying public properties instead.
### Release Notes ### Release Notes
1.4.0 1.4.0
* Add Go Modules, Update vendor folder (#26, #25)
* Add C.I. GitHub Actions (#25) * Add C.I. GitHub Actions (#25)
* Add Go Modules (#26) * Add additional error checks found by linters (#25)
* Go Fmt enclosure_test.go (#25)
1.3.2 1.3.2

14
doc.go
View File

@ -21,6 +21,16 @@
// //
// Full detailed Examples of the API are at https://godoc.org/github.com/eduncan911/podcast. // Full detailed Examples of the API are at https://godoc.org/github.com/eduncan911/podcast.
// //
// Go Modules
//
// This library is supported on GoLang 1.7 and higher.
//
// We have implemented Go Modules support and the CI pipeline shows it working with
// new installs, tested with Go 1.13. To keep 1.7 compatibility, we use
// `go mod vendor` to maintain the `vendor/` folder for older 1.7 and later runtimes.
//
// If either runtime has an issue, please create an Issue and I will address.
//
// Extensibility // Extensibility
// //
// In no way are you restricted in having full control over your feeds. You may // In no way are you restricted in having full control over your feeds. You may
@ -61,8 +71,10 @@
// Release Notes // Release Notes
// //
// 1.4.0 // 1.4.0
// * Add Go Modules, Update vendor folder (#26, #25)
// * Add C.I. GitHub Actions (#25) // * Add C.I. GitHub Actions (#25)
// * Add Go Modules (#26) // * Add additional error checks found by linters (#25)
// * Go Fmt enclosure_test.go (#25)
// //
// 1.3.2 // 1.3.2
// * Correct count len of UTF8 strings (#9) // * Correct count len of UTF8 strings (#9)