Commit 23a8d445 authored by Nathan Harris's avatar Nathan Harris

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.
parent 3b5faf04
Pipeline #65117205 passed with stages
in 6 minutes and 42 seconds
[![License](https://img.shields.io/badge/License-Apache%202.0-yellow.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
[![Build](https://img.shields.io/circleci/project/github/Mordil/nio-redis/master.svg?logo=circleci)](https://circleci.com/gh/Mordil/nio-redis/tree/master)
| :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: |
|---|
[![License](https://img.shields.io/badge/License-Apache%202.0-yellow.svg)](./LICENSE.txt)
[![Build](https://gitlab.com/Mordil/swift-redis-nio-client/badges/master/pipeline.svg)](https://gitlab.com/Mordil/swift-redis-nio-client/pipelines)
[![Swift](https://img.shields.io/badge/Swift-5.0-brightgreen.svg?colorA=orange&colorB=4E4E4E)](https://swift.org)
[![Redis](https://img.shields.io/badge/Redis-5-brightgreen.svg?colorA=red&colorB=4E4E4E)](https://redis.io/download)
......@@ -9,25 +12,27 @@ A non-blocking Swift client for [Redis](https://redis.io/) built on top of [Swif
This package defines everything you need to work with Redis through the [**Re**dis **S**eralization **P**rotocol (RESP)](https://redis.io/topics/protocol).
* Swift Server Working Group Proposal: [SSWG-0004](https://github.com/swift-server/sswg/blob/d391da355718a8f396ef86b3563910089d5e5992/proposals/0004-nio-redis.md)
* [Pitch thread](https://forums.swift.org/t/swiftnio-redis-client/19325)
* [Discussion Thread](https://forums.swift.org/t/discussion-nioredis-nio-based-redis-driver/22455/)
**RedisNIO** is part of the [Swift on Server Working Group](https://github.com/swift-server/sswg) ecosystem.
| Proposal | Pitch | Discussion | Review | Vote |
|----------|-------|------------|--------|------|
| [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** |
## Installation
## :package: Installation
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)
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)
```swift
dependencies: [
.package(url: "https://github.com/Mordil/swift-redis-nio-client.git", .upToNextMinor(from: "0.8.0")
.package(url: "https://github.com/Mordil/swift-redis-nio-client.git", from: "1.0.0-alpha.1")
]
```
and run the following command: `swift package resolve`
## Getting Started
## :zap: Getting Started
`RedisNIO` is ready to use right after installation.
**RedisNIO** is ready to use right after installation.
```swift
import RedisNIO
......@@ -44,14 +49,20 @@ let result = try connection.set("my_key", to: "some value")
print(result) // Optional("some value")
```
## Contributing
## :closed_book: Documentation
API Documentation is generated every time a new release is published.
The latest version's docs are always available at https://mordil.gitlab.io/swift-redis-nio-client
## :construction: Contributing
Check out [CONTRIBUTING.md](CONTRIBUTING.md) for more information on how to help with RedisNIO.
Check out [CONTRIBUTING.md](CONTRIBUTING.md) for more information on how to help with **RedisNIO**.
It is highly recommended to use [Docker](https://docker.com) to install Redis locally.
```bash
docker run -d -p 6379:6379 --name redisnio redis:5
docker run -d -p 6379:6379 --name redis redis:5
```
Otherwise, install Redis directly on your machine from [Redis.io](https://redis.io/download).
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment