Skip to content

Commit

Permalink
Absolute URLs in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@freak4pc
freak4pc committed Apr 21, 2024
1 parent 6b837a2 commit f06fa46
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 42 deletions.
34 changes: 13 additions & 21 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,34 +27,34 @@ KVO observation, async operations, UI Events and other streams of data are all u

###### ... understand

* [why use rx?](Documentation/Why.md)
* [the basics, getting started with RxSwift](Documentation/GettingStarted.md)
* [traits](Documentation/Traits.md) - what are `Single`, `Completable`, `Maybe`, `Driver`, and `ControlProperty` ... and why do they exist?
* [testing](Documentation/UnitTests.md)
* [tips and common errors](Documentation/Tips.md)
* [debugging](Documentation/GettingStarted.md#debugging)
* [the math behind Rx](Documentation/MathBehindRx.md)
* [what are hot and cold observable sequences?](Documentation/HotAndColdObservables.md)
* [why use rx?](https://github.com/ReactiveX/RxSwift/blob/main/Documentation/Why.md)
* [the basics, getting started with RxSwift](https://github.com/ReactiveX/RxSwift/blob/main/Documentation/GettingStarted.md)
* [traits](https://github.com/ReactiveX/RxSwift/blob/main/Documentation/Traits.md) - what are `Single`, `Completable`, `Maybe`, `Driver`, and `ControlProperty` ... and why do they exist?
* [testing](https://github.com/ReactiveX/RxSwift/blob/main/Documentation/UnitTests.md)
* [tips and common errors](https://github.com/ReactiveX/RxSwift/blob/main/Documentation/Tips.md)
* [debugging](https://github.com/ReactiveX/RxSwift/blob/main/Documentation/GettingStarted.md#debugging)
* [the math behind Rx](https://github.com/ReactiveX/RxSwift/blob/main/Documentation/MathBehindRx.md)
* [what are hot and cold observable sequences?](https://github.com/ReactiveX/RxSwift/blob/main/Documentation/HotAndColdObservables.md)

###### ... install

* Integrate RxSwift/RxCocoa with my app. [Installation Guide](#installation)

###### ... hack around

* with the example app. [Running Example App](Documentation/ExampleApp.md)
* with operators in playgrounds. [Playgrounds](Documentation/Playgrounds.md)
* with the example app. [Running Example App](https://github.com/ReactiveX/RxSwift/blob/main/Documentation/ExampleApp.md)
* with operators in playgrounds. [Playgrounds](https://github.com/ReactiveX/RxSwift/blob/main/Documentation/Playgrounds.md)

###### ... interact

* All of this is great, but it would be nice to talk with other people using RxSwift and exchange experiences. <br />[Join Slack Channel](http://slack.rxswift.org)
* Report a problem using the library. [Open an Issue With Bug Template](.github/ISSUE_TEMPLATE.md)
* Report a problem using the library. [Open an Issue With Bug Template](https://github.com/ReactiveX/RxSwift/blob/main/.github/ISSUE_TEMPLATE.md)
* Request a new feature. [Open an Issue With Feature Request Template](Documentation/NewFeatureRequestTemplate.md)
* Help out [Check out contribution guide](CONTRIBUTING.md)
* Help out [Check out contribution guide](https://github.com/ReactiveX/RxSwift/blob/main/CONTRIBUTING.md)

###### ... compare

* [with Combine and ReactiveSwift](Documentation/ComparisonWithOtherLibraries.md).
* [with Combine and ReactiveSwift](https://github.com/ReactiveX/RxSwift/blob/main/Documentation/ComparisonWithOtherLibraries.md).

###### ... understand the structure

Expand Down Expand Up @@ -121,14 +121,6 @@ searchResults
</tr>
</table>


## Requirements

* Xcode 12.x
* Swift 5.x

For Xcode 11 and below, [use RxSwift 5.x](https://github.com/ReactiveX/RxSwift/releases/tag/5.1.1).

## Installation

RxSwift doesn't contain any external dependencies.
Expand Down
34 changes: 13 additions & 21 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -371,14 +371,14 @@ <h2 id='i-came-here-because-i-want-to' class='heading'>I came here because I wan
<h6 id='understand' class='heading'>&hellip; understand</h6>

<ul>
<li><a href="Documentation/Why.md">why use rx?</a></li>
<li><a href="Documentation/GettingStarted.md">the basics, getting started with RxSwift</a></li>
<li><a href="Documentation/Traits.md">traits</a> - what are <code><a href="RxSwift%2FTraits%2FPrimitiveSequence.html#/s:7RxSwift6Singlea">Single</a></code>, <code><a href="RxSwift%2FTraits%2FPrimitiveSequence.html#/s:7RxSwift11Completablea">Completable</a></code>, <code><a href="RxSwift%2FTraits%2FPrimitiveSequence.html#/s:7RxSwift5Maybea">Maybe</a></code>, <code>Driver</code>, and <code>ControlProperty</code> &hellip; and why do they exist?</li>
<li><a href="Documentation/UnitTests.md">testing</a></li>
<li><a href="Documentation/Tips.md">tips and common errors</a></li>
<li><a href="Documentation/GettingStarted.md#debugging">debugging</a></li>
<li><a href="Documentation/MathBehindRx.md">the math behind Rx</a></li>
<li><a href="Documentation/HotAndColdObservables.md">what are hot and cold observable sequences?</a></li>
<li><a href="https://github.com/ReactiveX/RxSwift/blob/main/Documentation/Why.md">why use rx?</a></li>
<li><a href="https://github.com/ReactiveX/RxSwift/blob/main/Documentation/GettingStarted.md">the basics, getting started with RxSwift</a></li>
<li><a href="https://github.com/ReactiveX/RxSwift/blob/main/Documentation/Traits.md">traits</a> - what are <code><a href="RxSwift%2FTraits%2FPrimitiveSequence.html#/s:7RxSwift6Singlea">Single</a></code>, <code><a href="RxSwift%2FTraits%2FPrimitiveSequence.html#/s:7RxSwift11Completablea">Completable</a></code>, <code><a href="RxSwift%2FTraits%2FPrimitiveSequence.html#/s:7RxSwift5Maybea">Maybe</a></code>, <code>Driver</code>, and <code>ControlProperty</code> &hellip; and why do they exist?</li>
<li><a href="https://github.com/ReactiveX/RxSwift/blob/main/Documentation/UnitTests.md">testing</a></li>
<li><a href="https://github.com/ReactiveX/RxSwift/blob/main/Documentation/Tips.md">tips and common errors</a></li>
<li><a href="https://github.com/ReactiveX/RxSwift/blob/main/Documentation/GettingStarted.md#debugging">debugging</a></li>
<li><a href="https://github.com/ReactiveX/RxSwift/blob/main/Documentation/MathBehindRx.md">the math behind Rx</a></li>
<li><a href="https://github.com/ReactiveX/RxSwift/blob/main/Documentation/HotAndColdObservables.md">what are hot and cold observable sequences?</a></li>
</ul>
<h6 id='install' class='heading'>&hellip; install</h6>

Expand All @@ -388,21 +388,21 @@ <h6 id='install' class='heading'>&hellip; install</h6>
<h6 id='hack-around' class='heading'>&hellip; hack around</h6>

<ul>
<li>with the example app. <a href="Documentation/ExampleApp.md">Running Example App</a></li>
<li>with operators in playgrounds. <a href="Documentation/Playgrounds.md">Playgrounds</a></li>
<li>with the example app. <a href="https://github.com/ReactiveX/RxSwift/blob/main/Documentation/ExampleApp.md">Running Example App</a></li>
<li>with operators in playgrounds. <a href="https://github.com/ReactiveX/RxSwift/blob/main/Documentation/Playgrounds.md">Playgrounds</a></li>
</ul>
<h6 id='interact' class='heading'>&hellip; interact</h6>

<ul>
<li>All of this is great, but it would be nice to talk with other people using RxSwift and exchange experiences. <br /><a href="http://slack.rxswift.org">Join Slack Channel</a></li>
<li>Report a problem using the library. <a href=".github/ISSUE_TEMPLATE.md">Open an Issue With Bug Template</a></li>
<li>Report a problem using the library. <a href="https://github.com/ReactiveX/RxSwift/blob/main/.github/ISSUE_TEMPLATE.md">Open an Issue With Bug Template</a></li>
<li>Request a new feature. <a href="Documentation/NewFeatureRequestTemplate.md">Open an Issue With Feature Request Template</a></li>
<li>Help out <a href="CONTRIBUTING.md">Check out contribution guide</a></li>
<li>Help out <a href="https://github.com/ReactiveX/RxSwift/blob/main/CONTRIBUTING.md">Check out contribution guide</a></li>
</ul>
<h6 id='compare' class='heading'>&hellip; compare</h6>

<ul>
<li><a href="Documentation/ComparisonWithOtherLibraries.md">with Combine and ReactiveSwift</a>.</li>
<li><a href="https://github.com/ReactiveX/RxSwift/blob/main/Documentation/ComparisonWithOtherLibraries.md">with Combine and ReactiveSwift</a>.</li>
</ul>
<h6 id='understand-the-structure' class='heading'>&hellip; understand the structure</h6>

Expand Down Expand Up @@ -467,14 +467,6 @@ <h2 id='usage' class='heading'>Usage</h2>
.disposed(by: disposeBag)</pre></div></td>
</tr>
</table>
<h2 id='requirements' class='heading'>Requirements</h2>

<ul>
<li>Xcode 12.x</li>
<li>Swift 5.x</li>
</ul>

<p>For Xcode 11 and below, <a href="https://github.com/ReactiveX/RxSwift/releases/tag/5.1.1">use RxSwift 5.x</a>.</p>
<h2 id='installation' class='heading'>Installation</h2>

<p>RxSwift doesn&rsquo;t contain any external dependencies.</p>
Expand Down

0 comments on commit f06fa46

Please sign in to comment.