Skip to content

Commit 22735fc

Browse files
committed
Update docs.
1 parent ac8e7fa commit 22735fc

25 files changed

+71
-71
lines changed

CODE_OF_CONDUCT.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Code of Conduct
2-
To be a truly great community, NIOApns needs to welcome developers from all walks of life,
2+
To be a truly great community, APNSwift needs to welcome developers from all walks of life,
33
with different backgrounds, and with a wide range of experience. A diverse and friendly
44
community will have more great ideas, more unique perspectives, and produce more great
5-
code. We will work diligently to make the NIOApns community welcoming to everyone.
5+
code. We will work diligently to make the APNSwift community welcoming to everyone.
66

7-
To give clarity of what is expected of our members, NIOApns has adopted the code of conduct
7+
To give clarity of what is expected of our members, APNSwift has adopted the code of conduct
88
defined by [contributor-covenant.org](https://www.contributor-covenant.org). This document is used across many open source
99
communities, and we think it articulates our values well. The full text is copied below:
1010

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ that your contributions are licensed under the [Apache 2.0 license](https://www.
77

88
Please ensure to specify the following:
99

10-
* NIOApns commit hash
10+
* APNSwift commit hash
1111
* Simplest possible steps to reproduce
1212
* A pull request with a failing test case is preferred, but it's just as fine to write it in the issue description
1313
* Environment Information

CONTRIBUTORS.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
For the purpose of tracking copyright, this is the list of individuals and
2-
organizations who have contributed source code to NIOApns.
2+
organizations who have contributed source code to APNSwift.
33

44
For employees of an organization/company where the copyright of work done
55
by employees of that company is held by the company itself, only the company

NOTICE.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
//===----------------------------------------------------------------------===//
22
//
3-
// This source file is part of the NIOApns open source project
3+
// This source file is part of the APNSwift open source project
44
//
5-
// Copyright (c) 2019 the NIOApns project authors
5+
// Copyright (c) 2019 the APNSwift project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information
9-
// See CONTRIBUTORS.txt for the list of NIOApns project authors
9+
// See CONTRIBUTORS.txt for the list of APNSwift project authors
1010
//
1111
// SPDX-License-Identifier: Apache-2.0
1212
//

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
[![Build](https://img.shields.io/circleci/project/github/kylebrowning/swift-nio-apns/master.svg?logo=circleci)](https://circleci.com/gh/kylebrowning/swift-nio-apns/tree/master)
33
[![Swift](https://img.shields.io/badge/Swift-5.0-brightgreen.svg?colorA=orange&colorB=4E4E4E)](https://swift.org)
44

5-
# NIOApns
5+
# APNSwift
66

77
A non-blocking Swift module for sending remote Apple Push Notification requests to [APNS](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server) built on http/2, SwiftNIO for use on server side swift platforms.
88

99
## Installation
1010

11-
To install `NIOSAPNS`, just add the package as a dependency in your [**Package.swift**](https://github.com/apple/swift-package-manager/blob/master/Documentation/PackageDescriptionV4.md#dependencies). Though you may want to consider using master branch until approved by the SSWG.
11+
To install `APNSwift`, just add the package as a dependency in your [**Package.swift**](https://github.com/apple/swift-package-manager/blob/master/Documentation/PackageDescriptionV4.md#dependencies). Though you may want to consider using master branch until approved by the SSWG.
1212

1313
```swift
1414
dependencies: [

Sources/APNSwift/APNSSwiftJWT/APNSwiftJWT.swift

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
//===----------------------------------------------------------------------===//
22
//
3-
// This source file is part of the NIOApns open source project
3+
// This source file is part of the APNSwift open source project
44
//
5-
// Copyright (c) 2019 the NIOApns project authors
5+
// Copyright (c) 2019 the APNSwift project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information
9-
// See CONTRIBUTORS.txt for the list of NIOApns project authors
9+
// See CONTRIBUTORS.txt for the list of APNSwift project authors
1010
//
1111
// SPDX-License-Identifier: Apache-2.0
1212
//

Sources/APNSwift/APNSSwiftJWT/APNSwiftJWTError.swift

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
//===----------------------------------------------------------------------===//
22
//
3-
// This source file is part of the NIOApns open source project
3+
// This source file is part of the APNSwift open source project
44
//
5-
// Copyright (c) 2019 the NIOApns project authors
5+
// Copyright (c) 2019 the APNSwift project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information
9-
// See CONTRIBUTORS.txt for the list of NIOApns project authors
9+
// See CONTRIBUTORS.txt for the list of APNSwift project authors
1010
//
1111
// SPDX-License-Identifier: Apache-2.0
1212
//

Sources/APNSwift/APNSSwiftJWT/Data+Base64URL.swift

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
//===----------------------------------------------------------------------===//
22
//
3-
// This source file is part of the NIOApns open source project
3+
// This source file is part of the APNSwift open source project
44
//
5-
// Copyright (c) 2019 the NIOApns project authors
5+
// Copyright (c) 2019 the APNSwift project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information
9-
// See CONTRIBUTORS.txt for the list of NIOApns project authors
9+
// See CONTRIBUTORS.txt for the list of APNSwift project authors
1010
//
1111
// SPDX-License-Identifier: Apache-2.0
1212
//

Sources/APNSwift/APNSwiftConfiguration.swift

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
//===----------------------------------------------------------------------===//
22
//
3-
// This source file is part of the NIOApns open source project
3+
// This source file is part of the APNSwift open source project
44
//
5-
// Copyright (c) 2019 the NIOApns project authors
5+
// Copyright (c) 2019 the APNSwift project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information
9-
// See CONTRIBUTORS.txt for the list of NIOApns project authors
9+
// See CONTRIBUTORS.txt for the list of APNSwift project authors
1010
//
1111
// SPDX-License-Identifier: Apache-2.0
1212
//

Sources/APNSwift/APNSwiftConnection.swift

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
//===----------------------------------------------------------------------===//
22
//
3-
// This source file is part of the NIOApns open source project
3+
// This source file is part of the APNSwift open source project
44
//
5-
// Copyright (c) 2019 the NIOApns project authors
5+
// Copyright (c) 2019 the APNSwift project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information
9-
// See CONTRIBUTORS.txt for the list of NIOApns project authors
9+
// See CONTRIBUTORS.txt for the list of APNSwift project authors
1010
//
1111
// SPDX-License-Identifier: Apache-2.0
1212
//

Sources/APNSwift/APNSwiftErrors.swift

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
//===----------------------------------------------------------------------===//
22
//
3-
// This source file is part of the NIOApns open source project
3+
// This source file is part of the APNSwift open source project
44
//
5-
// Copyright (c) 2019 the NIOApns project authors
5+
// Copyright (c) 2019 the APNSwift project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information
9-
// See CONTRIBUTORS.txt for the list of NIOApns project authors
9+
// See CONTRIBUTORS.txt for the list of APNSwift project authors
1010
//
1111
// SPDX-License-Identifier: Apache-2.0
1212
//

Sources/APNSwift/APNSwiftRequest.swift

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
//===----------------------------------------------------------------------===//
22
//
3-
// This source file is part of the NIOApns open source project
3+
// This source file is part of the APNSwift open source project
44
//
5-
// Copyright (c) 2019 the NIOApns project authors
5+
// Copyright (c) 2019 the APNSwift project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information
9-
// See CONTRIBUTORS.txt for the list of NIOApns project authors
9+
// See CONTRIBUTORS.txt for the list of APNSwift project authors
1010
//
1111
// SPDX-License-Identifier: Apache-2.0
1212
//

Sources/APNSwift/APNSwiftRequestContext.swift

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
//===----------------------------------------------------------------------===//
22
//
3-
// This source file is part of the NIOApns open source project
3+
// This source file is part of the APNSwift open source project
44
//
5-
// Copyright (c) 2019 the NIOApns project authors
5+
// Copyright (c) 2019 the APNSwift project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information
9-
// See CONTRIBUTORS.txt for the list of NIOApns project authors
9+
// See CONTRIBUTORS.txt for the list of APNSwift project authors
1010
//
1111
// SPDX-License-Identifier: Apache-2.0
1212
//

Sources/APNSwift/APNSwiftRequestEncoder.swift

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
//===----------------------------------------------------------------------===//
22
//
3-
// This source file is part of the NIOApns open source project
3+
// This source file is part of the APNSwift open source project
44
//
5-
// Copyright (c) 2019 the NIOApns project authors
5+
// Copyright (c) 2019 the APNSwift project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information
9-
// See CONTRIBUTORS.txt for the list of NIOApns project authors
9+
// See CONTRIBUTORS.txt for the list of APNSwift project authors
1010
//
1111
// SPDX-License-Identifier: Apache-2.0
1212
//

Sources/APNSwift/APNSwiftResponse.swift

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
//===----------------------------------------------------------------------===//
22
//
3-
// This source file is part of the NIOApns open source project
3+
// This source file is part of the APNSwift open source project
44
//
5-
// Copyright (c) 2019 the NIOApns project authors
5+
// Copyright (c) 2019 the APNSwift project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information
9-
// See CONTRIBUTORS.txt for the list of NIOApns project authors
9+
// See CONTRIBUTORS.txt for the list of APNSwift project authors
1010
//
1111
// SPDX-License-Identifier: Apache-2.0
1212
//

Sources/APNSwift/APNSwiftResponseDecoder.swift

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
//===----------------------------------------------------------------------===//
22
//
3-
// This source file is part of the NIOApns open source project
3+
// This source file is part of the APNSwift open source project
44
//
5-
// Copyright (c) 2019 the NIOApns project authors
5+
// Copyright (c) 2019 the APNSwift project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information
9-
// See CONTRIBUTORS.txt for the list of NIOApns project authors
9+
// See CONTRIBUTORS.txt for the list of APNSwift project authors
1010
//
1111
// SPDX-License-Identifier: Apache-2.0
1212
//

Sources/APNSwift/APNSwiftSigner.swift

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
//===----------------------------------------------------------------------===//
22
//
3-
// This source file is part of the NIOApns open source project
3+
// This source file is part of the APNSwift open source project
44
//
5-
// Copyright (c) 2019 the NIOApns project authors
5+
// Copyright (c) 2019 the APNSwift project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information
9-
// See CONTRIBUTORS.txt for the list of NIOApns project authors
9+
// See CONTRIBUTORS.txt for the list of APNSwift project authors
1010
//
1111
// SPDX-License-Identifier: Apache-2.0
1212
//

Sources/APNSwift/APNSwiftStreamHandler.swift

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
//===----------------------------------------------------------------------===//
22
//
3-
// This source file is part of the NIOApns open source project
3+
// This source file is part of the APNSwift open source project
44
//
5-
// Copyright (c) 2019 the NIOApns project authors
5+
// Copyright (c) 2019 the APNSwift project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information
9-
// See CONTRIBUTORS.txt for the list of NIOApns project authors
9+
// See CONTRIBUTORS.txt for the list of APNSwift project authors
1010
//
1111
// SPDX-License-Identifier: Apache-2.0
1212
//

Sources/APNSwiftExample/main.swift

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
//===----------------------------------------------------------------------===//
22
//
3-
// This source file is part of the NIOApns open source project
3+
// This source file is part of the APNSwift open source project
44
//
5-
// Copyright (c) 2019 the NIOApns project authors
5+
// Copyright (c) 2019 the APNSwift project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information
9-
// See CONTRIBUTORS.txt for the list of NIOApns project authors
9+
// See CONTRIBUTORS.txt for the list of APNSwift project authors
1010
//
1111
// SPDX-License-Identifier: Apache-2.0
1212
//

Tests/APNSwiftJWTTests/JWTTests.swift

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
//===----------------------------------------------------------------------===//
22
//
3-
// This source file is part of the NIOApns open source project
3+
// This source file is part of the APNSwift open source project
44
//
5-
// Copyright (c) 2019 the NIOApns project authors
5+
// Copyright (c) 2019 the APNSwift project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information
9-
// See CONTRIBUTORS.txt for the list of NIOApns project authors
9+
// See CONTRIBUTORS.txt for the list of APNSwift project authors
1010
//
1111
// SPDX-License-Identifier: Apache-2.0
1212
//

Tests/APNSwiftJWTTests/XCTestManifests.swift

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
//===----------------------------------------------------------------------===//
22
//
3-
// This source file is part of the NIOApns open source project
3+
// This source file is part of the APNSwift open source project
44
//
5-
// Copyright (c) 2019 the NIOApns project authors
5+
// Copyright (c) 2019 the APNSwift project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information
9-
// See CONTRIBUTORS.txt for the list of NIOApns project authors
9+
// See CONTRIBUTORS.txt for the list of APNSwift project authors
1010
//
1111
// SPDX-License-Identifier: Apache-2.0
1212
//

Tests/APNSwiftTests/APNSwiftConfigurationTests.swift

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
//===----------------------------------------------------------------------===//
22
//
3-
// This source file is part of the NIOApns open source project
3+
// This source file is part of the APNSwift open source project
44
//
5-
// Copyright (c) 2019 the NIOApns project authors
5+
// Copyright (c) 2019 the APNSwift project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information
9-
// See CONTRIBUTORS.txt for the list of NIOApns project authors
9+
// See CONTRIBUTORS.txt for the list of APNSwift project authors
1010
//
1111
// SPDX-License-Identifier: Apache-2.0
1212
//

Tests/APNSwiftTests/APNSwiftRequestTests.swift

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
//===----------------------------------------------------------------------===//
22
//
3-
// This source file is part of the NIOApns open source project
3+
// This source file is part of the APNSwift open source project
44
//
5-
// Copyright (c) 2019 the NIOApns project authors
5+
// Copyright (c) 2019 the APNSwift project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information
9-
// See CONTRIBUTORS.txt for the list of NIOApns project authors
9+
// See CONTRIBUTORS.txt for the list of APNSwift project authors
1010
//
1111
// SPDX-License-Identifier: Apache-2.0
1212
//

Tests/APNSwiftTests/XCTestManifests.swift

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
//===----------------------------------------------------------------------===//
22
//
3-
// This source file is part of the NIOApns open source project
3+
// This source file is part of the APNSwift open source project
44
//
5-
// Copyright (c) 2019 the NIOApns project authors
5+
// Copyright (c) 2019 the APNSwift project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information
9-
// See CONTRIBUTORS.txt for the list of NIOApns project authors
9+
// See CONTRIBUTORS.txt for the list of APNSwift project authors
1010
//
1111
// SPDX-License-Identifier: Apache-2.0
1212
//

scripts/generate_contributors_list.sh

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
#!/bin/bash
22
##===----------------------------------------------------------------------===##
33
##
4-
## This source file is part of the NIOApns open source project
4+
## This source file is part of the APNSwift open source project
55
##
6-
## Copyright (c) 2019 the NIOApns project authors
6+
## Copyright (c) 2019 the APNSwift project authors
77
## Licensed under Apache License v2.0
88
##
99
## See LICENSE.txt for license information
@@ -19,7 +19,7 @@ contributors=$( cd "$here"/.. && git shortlog -es | cut -f2 | sed 's/^/- /' )
1919

2020
cat > "$here/../CONTRIBUTORS.txt" <<- EOF
2121
For the purpose of tracking copyright, this is the list of individuals and
22-
organizations who have contributed source code to NIOApns.
22+
organizations who have contributed source code to APNSwift.
2323
2424
For employees of an organization/company where the copyright of work done
2525
by employees of that company is held by the company itself, only the company
@@ -34,4 +34,4 @@ cat > "$here/../CONTRIBUTORS.txt" <<- EOF
3434
**Updating this list**
3535
3636
Please do not edit this file manually. It is generated using \`./scripts/generate_contributors_list.sh\`. If a name is misspelled or appearing multiple times: add an entry in \`./.mailmap\`
37-
EOF
37+
EOF

0 commit comments

Comments
 (0)