Skip to content

Commit

Permalink
reformat readme and update releaser
Browse files Browse the repository at this point in the history
  • Loading branch information
Jmfwolf committed Jul 13, 2023
1 parent 0006fb4 commit caec49a
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 35 deletions.
21 changes: 12 additions & 9 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,19 @@ jobs:
goreleaser:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Unshallow
run: git fetch --prune --unshallow
- name: Set up Go
uses: actions/setup-go@v2
- uses: actions/checkout@v3
with:
go-version: 1.14
- name: Release
uses: docker://antonyurchenko/git-release:latest
fetch-depth: 0
- run: git fetch --force --tags
- uses: actions/setup-go@v4
with:
go-version: stable
- uses: goreleaser/goreleaser-action@v4
with:
# either 'goreleaser' (default) or 'goreleaser-pro':
distribution: goreleaser
version: latest
args: release --clean
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
DRAFT_RELEASE: "false"
Expand Down
52 changes: 26 additions & 26 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# Onelogin Go SDK

This is the Onelogin SDK, a Go package that provides a convenient interface for interacting with Onelogin's API. The SDK simplifies the integration process by providing developers an easy-to-use tool for managing authentication, making API requests, and handling responses.
Expand All @@ -12,8 +11,8 @@ This is the Onelogin SDK, a Go package that provides a convenient interface for
- **Data Models**: Represent Onelogin entities and resources.
- **Utilities**: Provide utility functions and helper methods.


## Supported APIs

- [API Authorization](https://developers.onelogin.com/api-docs/2/api-authorization/overview)
- [Apps](https://developers.onelogin.com/api-docs/2/apps)
- [App Rules](https://developers.onelogin.com/api-docs/2/app-rules)
Expand All @@ -26,6 +25,7 @@ This is the Onelogin SDK, a Go package that provides a convenient interface for
- [User Mappings](https://developers.onelogin.com/api-docs/2/user-mappings)

## Partially Support APIs

- [MFA](https://developers.onelogin.com/api-docs/2/multi-factor-authentication)

## Installation
Expand Down Expand Up @@ -72,33 +72,33 @@ Here's an example demonstrating how to use the Onelogin SDK:
package main

import (
"fmt"
"fmt"

"github.com/onelogin/onelogin-go-sdk/v4/pkg/onelogin/models"
"github.com/onelogin/onelogin-go-sdk/v4/pkg/onelogin"
"github.com/onelogin/onelogin-go-sdk/v4/pkg/onelogin/models"
"github.com/onelogin/onelogin-go-sdk/v4/pkg/onelogin"
)

func main() {
ol, err := onelogin.NewOneloginSDK()
if err != nil {
fmt.Println("Unable to initialize client:", err)
return
}
userQuery := models.UserQuery{}
userList, err := ol.GetUsers(&userQuery)
if err != nil {
fmt.Println("Failed to get user:", err)
return
}
fmt.Println(userList)

appQuery := models.AppQuery{}
appList, err := ol.GetApps(&appQuery)
if err != nil {
fmt.Println("Failed to get app list:", err)
return
}
fmt.Println("App List:", appList)
ol, err := onelogin.NewOneloginSDK()
if err != nil {
fmt.Println("Unable to initialize client:", err)
return
}
userQuery := models.UserQuery{}
userList, err := ol.GetUsers(&userQuery)
if err != nil {
fmt.Println("Failed to get user:", err)
return
}
fmt.Println(userList)

appQuery := models.AppQuery{}
appList, err := ol.GetApps(&appQuery)
if err != nil {
fmt.Println("Failed to get app list:", err)
return
}
fmt.Println("App List:", appList)
}
```

Expand All @@ -115,4 +115,4 @@ func main() {

## Contributing

Contributions to the Onelogin SDK are welcome! If you encounter any issues or have suggestions for improvement, please open an issue or submit a pull request. We appreciate your feedback and contributions.
Contributions to the Onelogin SDK are welcome! If you encounter any issues or have suggestions for improvement, please open an issue or submit a pull request. We appreciate your feedback and contributions.

0 comments on commit caec49a

Please sign in to comment.