Skip to content

Commit

Permalink
mxcl.github.io|promisekit.org -> mxcl.dev
Browse files Browse the repository at this point in the history
* Fixes broken links
* Corrects spelling

[skip ci]
  • Loading branch information
mxcl committed Mar 1, 2019
1 parent b4176bd commit 91f002f
Show file tree
Hide file tree
Showing 9 changed files with 37 additions and 37 deletions.
4 changes: 2 additions & 2 deletions .github/PromiseKit.podspec
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ Pod::Spec.new do |s|

s.license = 'MIT'
s.summary = 'Promises for Swift & ObjC.'
s.homepage = 'http://promisekit.org'
s.homepage = 'http://mxcl.dev/PromiseKit/'
s.description = 'A thoughtful and complete implementation of promises for iOS, macOS, watchOS and tvOS with first-class support for both Objective-C and Swift.'
s.social_media_url = 'https://twitter.com/mxcl'
s.authors = { 'Max Howell' => '[email protected]' }
s.documentation_url = 'http://promisekit.org/docs/'
s.documentation_url = 'http://mxcl.dev/PromiseKit/reference/v6/Classes/Promise.html'
s.default_subspecs = 'CorePromise', 'UIKit', 'Foundation'
s.requires_arc = true

Expand Down
2 changes: 1 addition & 1 deletion Documentation/CommonPatterns.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ avoiding throwing an error because you couldn't be bothered to define a good glo
`Error` `enum`.


## Abstracting Away Asychronicity
## Abstracting Away Asynchronicity

```swift
var fetch = API.fetch()
Expand Down
10 changes: 5 additions & 5 deletions Documentation/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,11 @@ use `weak self` (and check for `self == nil`) to prevent any such side effects.
should be protected against are in fact *not* side effects.

Side effects include changes to global application state. They *do not* include
changing the display state of a viewController. So, protect against setting UserDefaults or
changing the display state of a view-controller. So, protect against setting `UserDefaults` or
modifying the application database, and don't bother protecting against changing
the text in a `UILabel`.

[This stackoverflow question](https://stackoverflow.com/questions/39281214/should-i-use-weak-self-in-promisekit-blocks)
[This StackOverflow question](https://stackoverflow.com/questions/39281214/should-i-use-weak-self-in-promisekit-blocks)
has some good discussion on this topic.

## Do I need to retain my promises?
Expand Down Expand Up @@ -211,12 +211,12 @@ to a suitable problem, RxSwift can yield great benefits in robustness and simpli
But not all applications are suitable for RxSwift.

By contrast, PromiseKit selectively applies the best parts of reactive programming
to the hardest part of pure Swift development, the management of asynchrony. It's a broadly
to the hardest part of pure Swift development, the management of asynchronicity. It's a broadly
applicable tool. Most asynchronous code can be clarified, simplified and made more robust
just by converting it to use promises. (And the conversion process is easy.)

Promises make for code that is clear to most developers. RxSwift, perhaps not. Take a look at this
[signup panel](https://github.com/ReactiveX/RxSwift/tree/master/RxExample/RxExample/Examples/GitHubSignup)
[sign-up panel](https://github.com/ReactiveX/RxSwift/tree/master/RxExample/RxExample/Examples/GitHubSignup)
implemented in RxSwift and see what you think. (Note that this is one of RxSwift's own examples.)

Even where PromiseKit and RxSwift are broadly similar, there are many differences in implementation:
Expand Down Expand Up @@ -244,7 +244,7 @@ deallocated. All promises yield a single value, terminate and then automatically

You can find some additional discussion in [this ticket](https://github.com/mxcl/PromiseKit/issues/484).

## Why can’t I return from a catch like I can in Javascript?
## Why can’t I return from a catch like I can in JavaScript?

Swift demands that functions have one purpose. Thus, we have two error handlers:

Expand Down
2 changes: 1 addition & 1 deletion Documentation/GettingStarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -532,4 +532,4 @@ different API (sorry about that, but Swift has changed a lot over the years and
we had to too).


[API Reference]: https://mxcl.github.io/PromiseKit/reference/v6/Classes/Promise.html
[API Reference]: https://mxcl.dev/PromiseKit/reference/v6/Classes/Promise.html
22 changes: 10 additions & 12 deletions Documentation/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,16 +63,14 @@ PromiseKit contains Swift, so there have been rev-lock issues with Xcode:

| PromiseKit | Swift | Xcode | CI Status | Release Notes |
| ---------- | ----------------------- | -------- | ------------ | ----------------- |
| 6 | 3.1, 3.2, 3.3, 4.x | 8.3, 9.x, 10.x | ![ci-master] | [2018/02][news-6] |
| 5 | 3.1, 3.2, 3.3, 4.x | 8.3, 9.x, 10.x | *Deprecated* | *n/a* |
| 4 | 3.0, 3.1, 3.2, 3.3, 4.x | 8.x, 9.x, 10.x | ![ci-master] | [2016/09][news-4] |
| 6 | 3.1, 3.2, 3.3, 4.x, 5.x | 8.3, 9.x, 10.x | ![ci-master] | [2018/02][news-6] |
| 5 | 3.1, 3.2, 3.3, 4.x | 8.3, 9.x, 10.1 | *Deprecated* | *n/a* |
| 4 | 3.0, 3.1, 3.2, 3.3, 4.x | 8.x, 9.x, 10.1 | ![ci-master] | [2016/09][news-4] |
| 3 | 2.x | 7.x, 8.0 | ![ci-swift2] | [2015/10][news-3] |
| 2 | 1.x | 7.x | *Deprecated* | [2015/10][news-3] |
| 1 | *N/A* | * | ![ci-legacy] ||
| 1 | *N/A* | * | ![ci-legacy] ||
† Probably supports Xcode 10 and Swift 4.2, if not, PR welcome.

‡ PromiseKit 1 is pure Objective-C and thus can be used with any Xcode, it is
† PromiseKit 1 is pure Objective-C and thus can be used with any Xcode, it is
also your only choice if you need to support iOS 7 or below.

---
Expand Down Expand Up @@ -109,10 +107,10 @@ github "mxcl/PromiseKit" ~> 3.5
[ci-23]: https://travis-ci.org/mxcl/PromiseKit.svg?branch=swift-2.3-minimal-changes
[ci-22]: https://travis-ci.org/mxcl/PromiseKit.svg?branch=swift-2.2-minimal-changes
[ci-20]: https://travis-ci.org/mxcl/PromiseKit.svg?branch=swift-2.0-minimal-changes
[news-2]: http://mxcl.github.io/PromiseKit/news/2015/05/PromiseKit-2.0-Released/
[news-3]: https://github.com/mxcl/PromiseKit/blob/master/CHANGELOG.markdown#300-oct-1st-2015
[news-4]: http://mxcl.github.io/PromiseKit/news/2016/09/PromiseKit-4.0-Released/
[news-6]: http://mxcl.github.io/PromiseKit/news/2018/02/PromiseKit-6.0-Released/
[news-2]: http://mxcl.dev/PromiseKit/news/2015/05/PromiseKit-2.0-Released/
[news-3]: https://github.com/mxcl/PromiseKit/blob/212f31f41864d1e3ec54f5dd529bd8e1e5697024/CHANGELOG.markdown#300-oct-1st-2015
[news-4]: http://mxcl.dev/PromiseKit/news/2016/09/PromiseKit-4.0-Released/
[news-6]: http://mxcl.dev/PromiseKit/news/2018/02/PromiseKit-6.0-Released/
[swift-2.3-minimal-changes]: https://github.com/mxcl/PromiseKit/tree/swift-2.3-minimal-changes
[swift-2.2-minimal-changes]: https://github.com/mxcl/PromiseKit/tree/swift-2.2-minimal-changes
[swift-2.0-minimal-changes]: https://github.com/mxcl/PromiseKit/tree/swift-2.0-minimal-changes
Expand Down Expand Up @@ -192,7 +190,7 @@ If you still are using Xcode 6 and Swift 1.2 then use PromiseKit 2.

## [2.0](https://github.com/mxcl/PromiseKit/releases/tag/2.0.0) May 14th, 2015

[PromiseKit 2 announcement post](http://mxcl.github.io/PromiseKit/news/2015/05/PromiseKit-2.0-Released/).
[PromiseKit 2 announcement post](http://mxcl.dev/PromiseKit/news/2015/05/PromiseKit-2.0-Released/).

## [1.5](https://github.com/mxcl/PromiseKit/releases/tag/1.5.0)

Expand Down
6 changes: 3 additions & 3 deletions Documentation/ObjectiveC.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ myPromise.then(^{
});
```

One important feature is the syntactic flexability of your handlers:
One important feature is the syntactic flexibility of your handlers:

```objc
myPromise.then(^{
Expand Down Expand Up @@ -192,7 +192,7 @@ that contains the throw statement.
This pattern will consequently result in memory leaks if you're not careful.

> *Note:* Only having a strong reference to the closure would result in memory leaks.
> In our case, PromisKit automatically keeps a strong reference to the closure until it's released.
> In our case, PromiseKit automatically keeps a strong reference to the closure until it's released.
__Workarounds:__

Expand All @@ -210,7 +210,7 @@ myPromise.then(^{
//…
});
```
2. Enable ARC for exceptions in Objective-C (not recomended)\
2. Enable ARC for exceptions in Objective-C (not recommended)\
You can add this ```-fobjc-arc-exceptions to your``` to your compiler flags to enable ARC for exceptions.
This is not recommended unless you've read the Apple documentation and are comfortable with the caveats.

Expand Down
4 changes: 2 additions & 2 deletions Documentation/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contents

* [README](/README.md)
* [README](../README.md)
* Handbook
* [Getting Started](GettingStarted.md)
* [Promises: Common Patterns](CommonPatterns.md)
Expand All @@ -11,4 +11,4 @@
* [Troubleshooting](Troubleshooting.md)
* [Appendix](Appendix.md)
* [Examples](Examples)
* [API Reference](https://mxcl.github.io/PromiseKit/reference/v6/Classes/Promise.html)
* [API Reference](https://mxcl.dev/PromiseKit/reference/v6/Classes/Promise.html)
4 changes: 2 additions & 2 deletions Documentation/Troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ closure entirely and giving you an error message that makes no sense at all.
When faced with this kind of enigmatic complaint, a good rule of thumb is to
double-check your argument and return types carefully. If everything looks OK,
temporarily add explicit type information as shown above, just to rule
out mis-inference as a possible cause.
out misinference as a possible cause.

### Try moving code to a temporary inline function

Expand Down Expand Up @@ -189,7 +189,7 @@ Yes: we hope they revert this change in Swift 5 too.

## "Ambiguous reference to 'firstly(execute:)'"

Remove the firstly, eg:
Remove the firstly, e.g.:

```swift
firstly {
Expand Down
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ recommend [Carthage](https://github.com/Carthage/Carthage).

# Professionally Supported PromiseKit is Now Available

Tidelift gives software development teams a single source for purchasing
TideLift gives software development teams a single source for purchasing
and maintaining their software, with professional grade assurances from
the experts who know it best, while seamlessly integrating with existing
tools.
Expand All @@ -72,15 +72,17 @@ tools.
# PromiseKit is Thousands of Hours of Work

Hey there, I’m Max Howell. I’m a prolific producer of open source software and
probably you already use some of it (for example, I created [`brew`]). I work
full-time on open source and it’s hard; currently *I earn less than minimum
wage*. Please help me continue my work, I appreciate it 🙏🏻
probably you already use some of it (I created [`brew`]). I work full-time on
open source and it’s hard; currently *I earn less than minimum wage*. Please
help me continue my work, I appreciate it 🙏🏻

<a href="https://www.patreon.com/mxcl">
<img src="https://c5.patreon.com/external/logo/[email protected]" width="160">
</a>

[Other ways to say thanks](http://mxcl.github.io/#donate).
[Other ways to say thanks](http://mxcl.dev/#donate).

[`brew`]: https://brew.sh

# Documentation

Expand All @@ -93,7 +95,7 @@ wage*. Please help me continue my work, I appreciate it 🙏🏻
* [Objective-C Guide](Documentation/ObjectiveC.md)
* [Troubleshooting](Documentation/Troubleshooting.md) (e.g., solutions to common compile errors)
* [Appendix](Documentation/Appendix.md)
* [API Reference](https://mxcl.github.io/PromiseKit/reference/v6/Classes/Promise.html)
* [API Reference](https://mxcl.dev/PromiseKit/reference/v6/Classes/Promise.html)

# Extensions

Expand Down Expand Up @@ -170,10 +172,10 @@ Nowadays, considering that:
* We almost always POST JSON
* We now have `JSONDecoder`
* PromiseKit now has `map` and other functional primitives
* PromiseKit (like Alamofire, but not raw-URLSession) also defaults to having callbacks go to the main thread
* PromiseKit (like Alamofire, but not raw-`URLSession`) also defaults to having callbacks go to the main thread

We recommend vanilla `URLSession`. It uses fewer black boxes and sticks closer to the
metal. Alamofire was essential until the three bulletpoints above became true,
metal. Alamofire was essential until the three bullet points above became true,
but nowadays it isn’t really necessary.

# Support
Expand All @@ -193,7 +195,7 @@ if after that you still have a question, ask at our [Gitter chat channel] or on
[Gitter chat channel]: https://gitter.im/mxcl/PromiseKit
[our bug tracker]: https://github.com/mxcl/PromiseKit/issues/new
[Podfile]: https://guides.cocoapods.org/syntax/podfile.html
[PMK6]: http://mxcl.github.io/PromiseKit/news/2018/02/PromiseKit-6.0-Released/
[PMK6]: http://mxcl.dev/PromiseKit/news/2018/02/PromiseKit-6.0-Released/
[Installation Guide]: Documentation/Installation.md
[badge-travis]: https://travis-ci.org/mxcl/PromiseKit.svg?branch=master
[travis]: https://travis-ci.org/mxcl/PromiseKit
Expand Down

0 comments on commit 91f002f

Please sign in to comment.