Skip to content

Commit d7c4121

Browse files
authored
README.md: Switch mirroring around (swift-server#56)
1 parent 8128baf commit d7c4121

File tree

4 files changed

+29
-35
lines changed

4 files changed

+29
-35
lines changed

CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
[SemVer](https://semver.org/) changes are documented for each release on the [releases page](https://gitlab.com/Mordil/RediStack/-/releases).
1+
[SemVer](https://semver.org/) changes are documented for each release on the [releases page](https://github.com/swift-server/RediStack/releases).

CONTRIBUTING.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,9 @@ docker run -d -p 6379:6379 --name redis redis:5
5151

5252
Otherwise, install Redis directly on your machine from [Redis.io](https://redis.io/download).
5353

54-
### Submitting a Merge Request
55-
56-
> The easiest way to create a great merge requests is to use one of the [Merge Request Templates](./.gitlab/merge_request_templates).
54+
### Submitting a Pull Request
5755

58-
A great MR that is likely to be merged quickly is:
56+
A great PR that is likely to be merged quickly is:
5957

6058
1. Concise, with as few changes as needed to achieve the end result.
6159
1. Tested, ensuring that regressions aren't introduced now or in the future.

README.md

+25-29
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,18 @@
1-
<div align="center">
2-
<p><img src="https://repository-images.githubusercontent.com/161592209/e0dfc700-a1c2-11e9-9302-a4b00958c76f" width="350" alt="RediStack logo"></p>
3-
4-
<p>
5-
<a href="https://github.com/swift-server/sswg/blob/master/process/incubation.md#sandbox-level"><img src="https://img.shields.io/badge/sswg-sandbox-lightgrey.svg" alt="SSWG Maturity"></a>
6-
<a href="https://gitlab.com/Mordil/RediStack/blob/master/LICENSE.txt"><img src="https://img.shields.io/badge/License-Apache%202.0-yellow.svg" alt="Apache 2 License"></a>
7-
<a href="https://swift.org"><img src="https://img.shields.io/badge/Swift-5.5+-orange.svg" alt="Swift 5.5+"></a>
8-
<a href="https://redis.io"><img src="https://img.shields.io/badge/Redis-5.0-red.svg" alt="Redis 5.0"></a>
9-
</p>
10-
11-
<p>
12-
<a href="https://gitlab.com/Mordil/RediStack/pipelines"><img src="https://gitlab.com/Mordil/RediStack/badges/master/pipeline.svg" alt="Build Status"></a>
13-
<a href="https://docs.redistack.info"><img src="https://docs.redistack.info/badge.svg" alt="Documentation Coverage"></a>
14-
</p>
15-
</div>
1+
# RediStack
2+
3+
[![SSWG Sandbox Incubating Badge](https://img.shields.io/badge/sswg-sandbox-lightgrey.svg)][SSWG Incubation]
4+
[![Documentation](http://img.shields.io/badge/read_the-docs-2196f3.svg)][Documentation]
5+
[![MIT License](http://img.shields.io/badge/license-Apache-brightgreen.svg)][Apache License]
6+
[![Swift 5.6](http://img.shields.io/badge/swift-5.6-brightgreen.svg)][Swift 5.6]
7+
8+
**RediStack** (pronounced like "ready stack") is a _non-blocking_ Swift client for [Redis](https://redis.io) built on top of [SwiftNIO](https://github.com/apple/swift-nio).
169

1710
<table><thead><tr align="center"><th width="9999">
18-
The <a href="https://github.com/Mordil/RediStack" rel="nofollow noreferrer noopener" target="_blank">GitHub repository</a> is a <b>read-only</b> mirror of the GitLab repository. For issues and merge requests, <a href="https://gitlab.com/mordil/RediStack" rel="nofollow noreferrer noopener" target="_blank">please visit GitLab</a>.
11+
The <a href="https://gitlab.com/swift-server-community/RediStack" rel="nofollow noreferrer noopener" target="_blank">GitLab repository</a> is a <b>read-only</b> mirror of the GitHub repository. For issues and pull requests, <a href="https://github.com/swift-server/RediStack" rel="nofollow noreferrer noopener" target="_blank">please visit GitHub</a>.
1912
</th></tr></thead></table>
2013

2114
## Introduction
2215

23-
**RediStack** (pronounced like "ready stack") is a _non-blocking_ Swift client for [Redis](https://redis.io) built on top of [SwiftNIO](https://github.com/apple/swift-nio).
24-
2516
It communicates over the network using Redis' [**Re**dis **S**eralization **P**rotocol (RESP2)](https://redis.io/topics/protocol).
2617

2718
This library is primarily developed for Redis v5, but is backwards compatible to Redis v3.
@@ -32,7 +23,7 @@ To install **RediStack**, just add the package as a dependency in your **Package
3223

3324
```swift
3425
dependencies: [
35-
.package(url: "https://gitlab.com/mordil/RediStack.git", from: "1.0.0")
26+
.package(url: "https://github.com/swift-server/RediStack.git", from: "1.4.1")
3627
]
3728
```
3829

@@ -61,29 +52,27 @@ print(result) // Optional("some value")
6152
6253
## Documentation
6354

64-
The docs for the latest tagged release are always available at [docs.redistack.info](http://docs.redistack.info).
55+
The docs for the latest tagged release are always available at the [Swift Package Index][Documentation].
6556

6657
## Questions
6758

68-
For bugs or feature requests, file a new [issue](https://gitlab.com/mordil/RediStack/-/issues).
69-
70-
For all other support requests, please email [[email protected]](mailto:[email protected]).
59+
For bugs or feature requests, file a new [issue](https://github.com/swift-server/RediStack/issues/new).
7160

7261
## Changelog
7362

74-
[SemVer](https://semver.org/) changes are documented for each release on the [releases page](https://gitlab.com/Mordil/RediStack/-/releases).
63+
[SemVer](https://semver.org/) changes are documented for each release on the [releases page][Releases].
7564

7665
## Contributing
7766

78-
Check out [CONTRIBUTING.md](https://gitlab.com/Mordil/RediStack/blob/master/CONTRIBUTING.md) for more information on how to help with **RediStack**.
67+
Check out [CONTRIBUTING.md](https://github.com/swift-server/RediStack/blob/main/CONTRIBUTING.md) for more information on how to help with **RediStack**.
7968

8069
## Contributors
8170

82-
Check out [CONTRIBUTORS.txt](https://gitlab.com/Mordil/RediStack/blob/master/CONTRIBUTORS.txt) to see the full list. This list is updated for each release.
71+
Check out [CONTRIBUTORS.txt](https://github.com/swift-server/RediStack/blob/main/CONTRIBUTORS.txt) to see the full list. This list is updated for each release.
8372

8473
## Swift on Server Ecosystem
8574

86-
**RediStack** is part of the [Swift on Server Working Group](https://github.com/swift-server/sswg) ecosystem - currently recommended as [**Sandbox Maturity**](https://github.com/swift-server/sswg/blob/master/process/incubation.md#sandbox-level).
75+
**RediStack** is part of the [Swift on Server Working Group][SSWG] ecosystem - currently recommended as [**Sandbox Maturity**][SSWG Incubation].
8776

8877
| Proposal | Pitch | Discussion | Review | Vote |
8978
|:---:|:---:|:---:|:---:|:---:|
@@ -101,12 +90,19 @@ This policy is to balance the desire for as much backwards compatibility as poss
10190

10291
## License
10392

104-
[Apache 2.0](https://gitlab.com/Mordil/RediStack/blob/master/LICENSE.txt)
93+
[Apache 2.0][Apache License]
10594

10695
Copyright (c) 2019-present, Nathan Harris (@mordil)
10796

108-
_This project contains code written by others not affliated with this project. All copyright claims are reserved by them. For a full list, with their claimed rights, see [NOTICE.txt](https://gitlab.com/Mordil/RediStack/blob/master/NOTICE.txt)_
97+
_This project contains code written by others not affliated with this project. All copyright claims are reserved by them. For a full list, with their claimed rights, see [NOTICE.txt](https://github.com/swift-server/RediStack/blob/main/NOTICE.txt)_
10998

11099
_**Redis** is a registered trademark of **Redis Labs**. Any use of their trademark is under the established [trademark guidelines](https://redis.io/topics/trademark) and does not imply any affiliation with or endorsement by them, and all rights are reserved by them._
111100

112101
_**Swift** is a registered trademark of **Apple, Inc**. Any use of their trademark does not imply any affiliation with or endorsement by them, and all rights are reserved by them._
102+
103+
[SSWG Incubation]: https://www.swift.org/sswg/incubation-process.html
104+
[SSWG]: https://www.swift.org/sswg/
105+
[Documentation]: https://swiftpackageindex.com/swift-server/RediStack/documentation
106+
[Apache License]: LICENSE.txt
107+
[Swift 5.6]: https://swift.org
108+
[Releases]: https://github.com/swift-server/RediStack/releases

Sources/RediStack/RESP/RESPTranslator.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ extension RESPTranslator {
9898
/// Possible errors thrown while parsing RESP messages.
9999
/// - Important: Any of these errors should be considered a **BUG**.
100100
///
101-
/// Please file a bug at [https://www.gitlab.com/mordil/RediStack/-/issues](https://www.gitlab.com/mordil/RediStack/-/issues).
101+
/// Please file a bug at [https://www.github.com/swift-server/RediStack/issues/new](https://www.github.com/swift-server/RediStack/issues/new).
102102
public struct ParsingError: LocalizedError, Equatable {
103103
/// An invalid RESP data type identifier was found.
104104
public static let invalidToken = ParsingError(.invalidToken)

0 commit comments

Comments
 (0)