-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
551f097
commit 15203a5
Showing
6 changed files
with
44 additions
and
69 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file modified
BIN
+127 Bytes
(100%)
...proj/project.xcworkspace/xcuserdata/vsanthanam.xcuserdatad/UserInterfaceState.xcuserstate
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,34 +1,27 @@ | ||
| # Nexum | ||
|
|
||
|  | ||
|  | ||
|  | ||
| [](https://developer.apple.com/library/content/documentation/Cocoa/Conceptual/ProgrammingWithObjectiveC/Introduction/Introduction.html) | ||
| [](https://en.wikipedia.org/wiki/MIT_License) | ||
| [](https://github.com/vsanthanam/Nexum/releases) | ||
| [](https://code.vsanthanam.com/Nexum/Documentation/) | ||
|
|
||
| Updated Reachability for iOS Apps in Objective-C, based on Apple's [Reachability](https://developer.apple.com/library/content/samplecode/Reachability/Introduction/Intro.html), along with some other network utilities | ||
|
|
||
| ## About | ||
| [](https://cocoapods.org/pods/VSAlert) | ||
|  | ||
|
|
||
| Apple appears to have stopped updating their Reachability code. It isn't marked up with nullability for use with Swift projects, it doesn't use ARC, and is generally inflexible. Nexum is a drop-in replacement for Apple's reachability that is still extremely similar and very simple, but designed for easy, drop-in use and more design flexibility. Not everyone wants to use NSNotification all the time :P | ||
|
|
||
| ## Requirements | ||
|
|
||
| Nexum is compiled with the iOS 11.2 SDK, but support iOS 9.x+ | ||
|
|
||
| ## Set Up | ||
| ## Setup | ||
|
|
||
| Take a look at the [Project Setup guide](https://code.vsanthanam.com/Nexum/Documentation/project-setup.html) for detailed step by step instruction on setting up your project and building the documentation locally. | ||
| For a quick start guide, see the [project website](https://nexum.vsanthanam.com). | ||
| The website is hosted on [GitHub Pages](https://pages.github.com), and is built using [Jekyll](https://jekyllrb.com) and [jekyll-docs-theme](https://github.com/vsanthanam/jekyll-docs-theme). | ||
|
|
||
| ## Usage | ||
| ## Documentation | ||
|
|
||
| Basic usage is pretty simple: | ||
| 1. Create and retain a reference to an instance of an `NXNetwork` object, or use the shared instance for basic projects. | ||
| 2. Observe changes in reachability using `NXNetworkDelegate`, `NXNetworkReachabilityStatusChangedNotification`, or a block. | ||
| Full documentation is available on the [project website](https://code.vsanthanam.com/Nexum/Documentation/index.html). Documentation is generated with [JazzyDoc](https://github.com/realm/jazzy), and styled using [Jony](https://github.com/HarshilShah/Jony). The hosted documentation is applicable for the latest version found under 'releases'. | ||
|
|
||
| See the [Designing for Reachability](https://code.vsanthanam.com/Nexum/Documentation/designing-for-reachability.html) for a detailed primer on potential different implentations, and see [Example - Basic Reachability](https://code.vsanthanam.com/Nexum/Documentation/example---basic-reachability.html) for a quick start. | ||
| ## Contribution Guidelines | ||
|
|
||
| ## Docs | ||
| See the [contribution guidelines](https://code.vsanthanam.com/Nexum/CONTRIBUTING.html) before contributing to the project. | ||
|
|
||
| The full documentaion is available [here](https://code.vsanthanam.com/Nexum/Documentation/), hosted on GitHub Pages, but is also included as an xcode docset. | ||
| ## Community Guidelines | ||
|
|
||
| Documentation with made with [Jazzy](https://github.com/realm/jazzy) by [Realm](https://realm.io), using the [Jony Theme](https://github.com/HarshilShah/Jony) by [Harshil Shah](https://github.com/HarshilShah/) | ||
| See the [code of conduct](https://code.vsanthanam.com/Nexum/CODE_OF_CONDUCT.html) for detailed participation rules. Please report all violations to [talkto@vsanthanam.com](mailto:talkto@vsanthanam.com) |
Binary file not shown.