You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
`JamfKit` is an iOS / macOS / tvOS framework to communicate with the JSS API offered by any Jamf host.
17
17
18
-
## Summary ##
18
+
## Summary
19
19
20
20
-[Features](#features)
21
21
-[Installation](#installation)
@@ -32,17 +32,17 @@
32
32
-[Credits](#credits)
33
33
-[License](#license)
34
34
35
-
## Features ##
35
+
## Features
36
36
37
37
-[x] Includes JSON encoding / decoding support for most of the JSS objects
38
38
-[x] Includes Objective-C support
39
-
-[x] Includes Swift 4+ support
39
+
-[x] Includes Swift 5+ support
40
40
-[x] Includes ready-for-consumption CRUD `URLRequest` for JSS endpoints
41
41
-[x] Includes demonstration playgrounds for class handling or request generation
42
42
43
-
## Installation ##
43
+
## Installation
44
44
45
-
### Carthage ###
45
+
### Carthage
46
46
47
47
To integrate `JamfKit` into your project, add the following line in your `Cartfile`:
48
48
@@ -54,7 +54,7 @@ Then run the following command:
54
54
55
55
`$ carthage update`
56
56
57
-
### Cocoapods ###
57
+
### Cocoapods
58
58
59
59
To integrate `JamfKit` into your project, add the following line in your `Podfile`:
60
60
@@ -72,9 +72,9 @@ Then run the following command:
72
72
73
73
`$ pod install`
74
74
75
-
## Architecture ##
75
+
## Architecture
76
76
77
-
### Protocols ###
77
+
### Protocols
78
78
79
79
|Protocol|Description|
80
80
|-----|-----|
@@ -83,14 +83,14 @@ Then run the following command:
83
83
|`Requestable`|Represents an object that can be used to perform requests with any JSS endpoint.|
84
84
|`Subset`|Represents any JSS object that contains a general object that can identify it.|
85
85
86
-
#### Requestable conformance ####
86
+
#### Requestable conformance
87
87
88
88
The class that conform to `Requestable` exposes the following elements:
89
89
90
90
- An failable initializer that takes a JSON payload and return the instantiated object
91
91
- A function to return the JSON payload that represents the instance of the object
92
92
93
-
### Classes ###
93
+
### Classes
94
94
95
95
|Class|Desscription|
96
96
|-----|-----|
@@ -117,21 +117,21 @@ Then run the following command:
117
117
|`SMTPServer`|Represents the physical SMTP server configuration.|
118
118
|`User`|Represents a Jamf user and contains the identification properties that are required to contact the actual user and identify the hardware devices assigned to him / her.|
119
119
120
-
## Usage ##
120
+
## Usage
121
121
122
-
### Getting started ###
122
+
### Getting started
123
123
124
-
#### Playgrounds ####
124
+
#### Playgrounds
125
125
126
126
To get a quick look on how you can use `JamfKit` in your `Jamf` related features, you can check the `Playgrounds` included within the workspace.
127
127
128
128
Also check the unit tests, they should cover most of your needs.
129
129
130
-
#### Models ####
130
+
#### Models
131
131
132
132
Most of the classes can be initialized with the bare minimul values, all the properties are then available for modification.
133
133
134
-
#### Requests ####
134
+
#### Requests
135
135
136
136
By adhering to the different CRUD protocols (`Creatable`, `Readable`, `Updatable` & `Deletable`), most of the JSS objects listed above are capable of supplying varying `URLRequest` that should fit any needs.
137
137
@@ -149,30 +149,30 @@ You'll find below the basic functions to get `URLRequest`:
149
149
150
150
Some objects will offer variants of those requests, like `MobileDevice` with `readRequestWithName()` or `deleteRequestWithSerialNumber()` (with both `static` and `instance` variants).
151
151
152
-
## Contributing ##
152
+
## Contributing
153
153
154
154
So, you want to help improve `JamfKit`? That's great! Any useful contribution is welcome!
155
155
156
156
Check [CONTRIBUTING](https://github.com/Ethenyl/JamfKit/blob/master/CONTRIBUTING.md) for more details on how you can contribute to `JamfKit`.
157
157
158
-
## Code of conduct ##
158
+
## Code of conduct
159
159
160
160
Any contributions (issues, pull requests, comments, etc.) to `JamfKit` are more than welcome.
161
161
162
162
But before making any contribution, please make sure that you follow the [CODE OF CONDUCT](https://github.com/Ethenyl/JamfKit/blob/master/CODE_OF_CONDUCT.md).
163
163
164
164
Otherwise, there's a great chance that your contribution will be removed / blocked / hidden.
165
165
166
-
## FAQ ##
166
+
## FAQ
167
167
168
168
None for the moment.
169
169
170
-
## Credits ##
170
+
## Credits
171
171
172
172
`JamfKit` is owned and maintained by [Ethenyl](https://github.com/Ethenyl).
173
173
174
174
You can join the list by contributing to the repository.
175
175
176
-
## License ##
176
+
## License
177
177
178
178
`JamfKit` is released under the MIT license. See [LICENSE](https://github.com/Ethenyl/JamfKit/blob/master/LICENSE) for more details.
0 commit comments