Skip to content

Commit

Permalink
Docs and module name
Browse files Browse the repository at this point in the history
  • Loading branch information
kgibson-spotnana committed Feb 20, 2024
1 parent 918a8e3 commit 25da6de
Show file tree
Hide file tree
Showing 9 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import (

func main() {
// Create a new Jumpcloud client
c, err := jcclient.NewClient("api_key")
c, err := jumpcloud.NewClient("api_key")

// Get all usergroups
g, err := c.GetAllUserGroups()
Expand Down
2 changes: 1 addition & 1 deletion app_models.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package jcclient
package jumpcloud

import "time"

Expand Down
2 changes: 1 addition & 1 deletion applications.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package jcclient
package jumpcloud

import (
"bytes"
Expand Down
8 changes: 4 additions & 4 deletions client.go
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
// jccclient is a package to interact with the JumpCloud API
// jumpcloud is a package to interact with the JumpCloud API
//
// # Create a new client
// c, err := jcclient.NewClient(os.Getenv("JC_API_KEY"))
// c, err := jumpcloud.NewClient(os.Getenv("JC_API_KEY"))
//
// # Use the Client
// groups, _ := c.GetAllUserGroups()
//

package jcclient
package jumpcloud

import (
"io"
Expand All @@ -28,7 +28,7 @@ type Client struct {
// NewClient factory returns a prepared client
//
// Example:
// c, err := jcclient.NewClient(os.Getenv("JC_API_KEY"))
// c, err := jumpcloud.NewClient(os.Getenv("JC_API_KEY"))
func NewClient(token string) (*Client, error) {
parsedUrl, err := url.Parse(HostURL)
c := Client{
Expand Down
2 changes: 1 addition & 1 deletion jc_test.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package jcclient
package jumpcloud

import (
"math/rand"
Expand Down
2 changes: 1 addition & 1 deletion usergroup_models.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package jcclient
package jumpcloud

// UserGroup is sensitive due to the null values being empty structs when calling the API
type UserGroup struct {
Expand Down
2 changes: 1 addition & 1 deletion usergroups.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package jcclient
package jumpcloud

import (
"bytes"
Expand Down
2 changes: 1 addition & 1 deletion users.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package jcclient
package jumpcloud

import (
"encoding/json"
Expand Down
2 changes: 1 addition & 1 deletion users_models.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package jcclient
package jumpcloud

import (
"time"
Expand Down

0 comments on commit 25da6de

Please sign in to comment.