Skip to content
This repository has been archived by the owner on Jun 27, 2024. It is now read-only.

Latest commit

 

History

History
121 lines (78 loc) · 4.84 KB

README.md

File metadata and controls

121 lines (78 loc) · 4.84 KB
Raw

SLRMDMConfig

Actions Status License: LGPL v3 Platforms: iOS | macOS | tvOS

Provides convenience methods for retrieving MDM configuration values.

Table of Contents

Getting Started

These instructions will get you up and running with SLRMDMConfig.

Installation

Requirements

Version Minimum Xcode Version Minimum macOS SDK Minimum iOS SDK Minimum tvOS SDK
1.0.0 -> Current 13.0 10.15 13.0 13.0

This library depends on a few system frameworks. If you have Modules and Link Frameworks Automatically enabled, then there isn't much that needs to be done. However, if you do not, you need to link against the Foundation framework.

Swift Package Installation

This is the recommended installation method. Follow the instructions provided by Apple using this repository's URL.

Binary Installation

You may download the latest binary from the releases page and then include it in your project.

Source Installation

If you want to build the library from source in your own project, you can either:

  1. Add the project as a submodule.
  2. Add the project as a subtree.
  3. Copy the source files directly into your project.

The submodule or subtree approaches are preferred over the copying of source files since you can easily obtain updates.

Carthage

If you do not already have Carthage installed, you can install it via Homebrew:

brew install carthage

Once Carthage is installed, add SLRMDMConfig to your Cartfile:

github "madsolar8582/SLRMDMConfig" ~> 1.0.0

Finally, run carthage and take the resulting SLRMDMConfig.framework and put it in your project.

CocoaPods

If you do not already have CocoaPods installed, you can install it via Homebrew or you can install it via gem:

brew install cocoapods

# OR

sudo gem install cocoapods # Note: sudo is required if you are installing to the system gemset

Once CocoaPods is installed, add SLRMDMConfig to your Podfile or to your Podspec as a dependency:

# Podfile
pod 'SLRMDMConfig', git: 'https://github.com/madsolar8582/SLRMDMConfig.git', tag: '1.0.0'

# Podspec
s.dependency 'SLRMDMConfig', git: 'https://github.com/madsolar8582/SLRMDMConfig.git', tag: '1.0.0'

Usage

To use this library, you just call the APIs provided on SLRMDMConfig to retrieve the specific kind of value you are looking for (very similar to NSUserDefaults).

Contributing

Please read CONTRIBUTING for details on how to contribute.

Support

Please read SUPPORT for details on how to get help with installation or usage.

License

This project is licensed under the LGPL v3 license.

Changes

Please read the CHANGELOG for details on the changes included in each release.

Versioning

This project uses Semantic Versioning for versioning. For the versions available, see the releases page.

Release Management

This project releases monthly if there are enough changes to warrant a release. However, if there are critical defects or inadvertent non-passive changes, a one-off release will be created for each impacted release series.

After a major version release, the older release series will stop receiving updates after 60 days and are then considered obsolete (and thus unsupported).