Skip to content

Commit 23a8d44

Browse files
committed
Update README
Motivation: After moving to GitLab, and while still having a GitHub mirror, it is important to drive people to the proper location for getting help and reporting bugs or feature requests. Also, some information should be updated to include new tags, formatting, and a link to the new API docs. Modifications: README is updated to point users to the GitLab repository and to have up-to-date information about the project. Result: Users should know where to reach project maintainers and where to find documentation.
1 parent 3b5faf0 commit 23a8d44

File tree

1 file changed

+24
-13
lines changed

1 file changed

+24
-13
lines changed

README.md

Lines changed: 24 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1-
[![License](https://img.shields.io/badge/License-Apache%202.0-yellow.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
2-
[![Build](https://img.shields.io/circleci/project/github/Mordil/nio-redis/master.svg?logo=circleci)](https://circleci.com/gh/Mordil/nio-redis/tree/master)
1+
| :bell: The [GitHub repository](https://github.com/Mordil/swift-redis-nio-client) is a **read-only** mirror of the GitLab repository. For issues and merge requests, [please visit GitLab](https://gitlab.com/mordil/swift-redis-nio-client). :bell: |
2+
|---|
3+
4+
[![License](https://img.shields.io/badge/License-Apache%202.0-yellow.svg)](./LICENSE.txt)
5+
[![Build](https://gitlab.com/Mordil/swift-redis-nio-client/badges/master/pipeline.svg)](https://gitlab.com/Mordil/swift-redis-nio-client/pipelines)
36
[![Swift](https://img.shields.io/badge/Swift-5.0-brightgreen.svg?colorA=orange&colorB=4E4E4E)](https://swift.org)
47
[![Redis](https://img.shields.io/badge/Redis-5-brightgreen.svg?colorA=red&colorB=4E4E4E)](https://redis.io/download)
58

@@ -9,25 +12,27 @@ A non-blocking Swift client for [Redis](https://redis.io/) built on top of [Swif
912

1013
This package defines everything you need to work with Redis through the [**Re**dis **S**eralization **P**rotocol (RESP)](https://redis.io/topics/protocol).
1114

12-
* Swift Server Working Group Proposal: [SSWG-0004](https://github.com/swift-server/sswg/blob/d391da355718a8f396ef86b3563910089d5e5992/proposals/0004-nio-redis.md)
13-
* [Pitch thread](https://forums.swift.org/t/swiftnio-redis-client/19325)
14-
* [Discussion Thread](https://forums.swift.org/t/discussion-nioredis-nio-based-redis-driver/22455/)
15+
**RedisNIO** is part of the [Swift on Server Working Group](https://github.com/swift-server/sswg) ecosystem.
16+
17+
| Proposal | Pitch | Discussion | Review | Vote |
18+
|----------|-------|------------|--------|------|
19+
| [SSWG-0004](https://github.com/swift-server/sswg/blob/master/proposals/0004-nio-redis.md) | [2019-01-07](https://forums.swift.org/t/swiftnio-redis-client/19325) | [2019-04-01](https://forums.swift.org/t/discussion-nioredis-nio-based-redis-driver/22455) | **TBD** | **TBD** |
1520

16-
## Installation
21+
## :package: Installation
1722

18-
To install `RedisNIO`, just add the package as a dependency in your [**Package.swift**](https://github.com/apple/swift-package-manager/blob/master/Documentation/PackageDescriptionV4.md#dependencies)
23+
To install **RedisNIO**, just add the package as a dependency in your [**Package.swift**](https://github.com/apple/swift-package-manager/blob/master/Documentation/PackageDescriptionV4.md#dependencies)
1924

2025
```swift
2126
dependencies: [
22-
.package(url: "https://github.com/Mordil/swift-redis-nio-client.git", .upToNextMinor(from: "0.8.0")
27+
.package(url: "https://github.com/Mordil/swift-redis-nio-client.git", from: "1.0.0-alpha.1")
2328
]
2429
```
2530

2631
and run the following command: `swift package resolve`
2732

28-
## Getting Started
33+
## :zap: Getting Started
2934

30-
`RedisNIO` is ready to use right after installation.
35+
**RedisNIO** is ready to use right after installation.
3136

3237
```swift
3338
import RedisNIO
@@ -44,14 +49,20 @@ let result = try connection.set("my_key", to: "some value")
4449
print(result) // Optional("some value")
4550
```
4651

47-
## Contributing
52+
## :closed_book: Documentation
53+
54+
API Documentation is generated every time a new release is published.
55+
56+
The latest version's docs are always available at https://mordil.gitlab.io/swift-redis-nio-client
57+
58+
## :construction: Contributing
4859

49-
Check out [CONTRIBUTING.md](CONTRIBUTING.md) for more information on how to help with RedisNIO.
60+
Check out [CONTRIBUTING.md](CONTRIBUTING.md) for more information on how to help with **RedisNIO**.
5061

5162
It is highly recommended to use [Docker](https://docker.com) to install Redis locally.
5263

5364
```bash
54-
docker run -d -p 6379:6379 --name redisnio redis:5
65+
docker run -d -p 6379:6379 --name redis redis:5
5566
```
5667

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

0 commit comments

Comments
 (0)