Skip to content

Commit

Permalink
updated docs & readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
@vsanthanam
vsanthanam committed Mar 25, 2018
1 parent 8034ef6 commit 7af8b05
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 19 deletions.
9 changes: 3 additions & 6 deletions Documentation/docsets/Nexum.docset/Contents/Resources/Documents/index.html
View file
Expand Up @@ -53,12 +53,9 @@ <h2 id='about' class='heading'>About</h2>
<h2 id='requirements' class='heading'>Requirements</h2>

<p>Nexum is compiled with the iOS 11.2 SDK, but support iOS 9.x+</p>
<h2 id='download' class='heading'>Download</h2>

<p>You can get the latest production ready release <a href="https://github.com/vsanthanam/Nexum/releases/latest">here</a></p>
<h2 id='set-up' class='heading'>Set Up</h2>

<p>Take a look at the <a href="https://vsanthanam.github.io/Nexum/Documentation/project-setup.html">Project Setup guide</a> for detailed step by step instruction on setting up your project and building the documentation locally.</p>
<p>Take a look at the <a href="https://code.vsanthanam.com/Nexum/Documentation/project-setup.html">Project Setup guide</a> for detailed step by step instruction on setting up your project and building the documentation locally.</p>
<h2 id='usage' class='heading'>Usage</h2>

<p>Basic usage is pretty simple:</p>
Expand All @@ -68,10 +65,10 @@ <h2 id='usage' class='heading'>Usage</h2>
<li>Observe changes in reachability using <code><a href="Protocols/NXNetworkDelegate.html">NXNetworkDelegate</a></code>, <code>NXNetworkReachabilityStatusChangedNotification</code>, or a block.</li>
</ol>

<p>See the <a href="https://vsanthanam.github.io/Nexum/Documentation/designing-for-reachability.html">Designing for Reachability</a> for a detailed primer on potential different implentations, and see <a href="https://vsanthanam.github.io/Nexum/Documentation/example---basic-reachability.html">Example - Basic Reachability</a> for a quick start.</p>
<p>See the <a href="https://code.vsanthanam.com/Nexum/Documentation/designing-for-reachability.html">Designing for Reachability</a> for a detailed primer on potential different implentations, and see <a href="https://code.vsanthanam.com/Nexum/Documentation/example---basic-reachability.html">Example - Basic Reachability</a> for a quick start.</p>
<h2 id='docs' class='heading'>Docs</h2>

<p>The full documentaion is available <a href="https://vsanthanam.github.io/Nexum/Documentation/">here</a>, hosted on GitHub Pages, but is also included as an xcode docset.</p>
<p>The full documentaion is available <a href="https://code.vsanthanam.com/Nexum/Documentation/">here</a>, hosted on GitHub Pages, but is also included as an xcode docset.</p>

<p>Documentation with made with <a href="https://github.com/realm/jazzy">Jazzy</a> by <a href="https://realm.io">Realm</a>, using the <a href="https://github.com/HarshilShah/Jony">Jony Theme</a> by <a href="https://github.com/HarshilShah/">Harshil Shah</a></p>

Expand Down
Binary file modified Documentation/docsets/Nexum.tgz
View file
Binary file not shown.
9 changes: 3 additions & 6 deletions Documentation/index.html
View file
Expand Up @@ -53,12 +53,9 @@ <h2 id='about' class='heading'>About</h2>
<h2 id='requirements' class='heading'>Requirements</h2>

<p>Nexum is compiled with the iOS 11.2 SDK, but support iOS 9.x+</p>
<h2 id='download' class='heading'>Download</h2>

<p>You can get the latest production ready release <a href="https://github.com/vsanthanam/Nexum/releases/latest">here</a></p>
<h2 id='set-up' class='heading'>Set Up</h2>

<p>Take a look at the <a href="https://vsanthanam.github.io/Nexum/Documentation/project-setup.html">Project Setup guide</a> for detailed step by step instruction on setting up your project and building the documentation locally.</p>
<p>Take a look at the <a href="https://code.vsanthanam.com/Nexum/Documentation/project-setup.html">Project Setup guide</a> for detailed step by step instruction on setting up your project and building the documentation locally.</p>
<h2 id='usage' class='heading'>Usage</h2>

<p>Basic usage is pretty simple:</p>
Expand All @@ -68,10 +65,10 @@ <h2 id='usage' class='heading'>Usage</h2>
<li>Observe changes in reachability using <code><a href="Protocols/NXNetworkDelegate.html">NXNetworkDelegate</a></code>, <code>NXNetworkReachabilityStatusChangedNotification</code>, or a block.</li>
</ol>

<p>See the <a href="https://vsanthanam.github.io/Nexum/Documentation/designing-for-reachability.html">Designing for Reachability</a> for a detailed primer on potential different implentations, and see <a href="https://vsanthanam.github.io/Nexum/Documentation/example---basic-reachability.html">Example - Basic Reachability</a> for a quick start.</p>
<p>See the <a href="https://code.vsanthanam.com/Nexum/Documentation/designing-for-reachability.html">Designing for Reachability</a> for a detailed primer on potential different implentations, and see <a href="https://code.vsanthanam.com/Nexum/Documentation/example---basic-reachability.html">Example - Basic Reachability</a> for a quick start.</p>
<h2 id='docs' class='heading'>Docs</h2>

<p>The full documentaion is available <a href="https://vsanthanam.github.io/Nexum/Documentation/">here</a>, hosted on GitHub Pages, but is also included as an xcode docset.</p>
<p>The full documentaion is available <a href="https://code.vsanthanam.com/Nexum/Documentation/">here</a>, hosted on GitHub Pages, but is also included as an xcode docset.</p>

<p>Documentation with made with <a href="https://github.com/realm/jazzy">Jazzy</a> by <a href="https://realm.io">Realm</a>, using the <a href="https://github.com/HarshilShah/Jony">Jony Theme</a> by <a href="https://github.com/HarshilShah/">Harshil Shah</a></p>

Expand Down
10 changes: 3 additions & 7 deletions README.md
View file
Expand Up @@ -10,24 +10,20 @@ Apple appears to have stopped updating their Reachability code. It isn't marked

Nexum is compiled with the iOS 11.2 SDK, but support iOS 9.x+

## Download

You can get the latest production ready release [here](https://github.com/vsanthanam/Nexum/releases/latest)

## Set Up

Take a look at the [Project Setup guide](https://vsanthanam.github.io/Nexum/Documentation/project-setup.html) for detailed step by step instruction on setting up your project and building the documentation locally.
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.

## Usage

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.

See the [Designing for Reachability](https://vsanthanam.github.io/Nexum/Documentation/designing-for-reachability.html) for a detailed primer on potential different implentations, and see [Example - Basic Reachability](https://vsanthanam.github.io/Nexum/Documentation/example---basic-reachability.html) for a quick start.
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.

## Docs

The full documentaion is available [here](https://vsanthanam.github.io/Nexum/Documentation/), hosted on GitHub Pages, but is also included as an xcode docset.
The full documentaion is available [here](https://code.vsanthanam.com/Nexum/Documentation/), hosted on GitHub Pages, but is also included as an xcode docset.

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/)
Binary file modified Release/Nexum.framework/Nexum
View file
Binary file not shown.

0 comments on commit 7af8b05

Please sign in to comment.