Skip to content

Commit f21e09a

Browse files
committed
Fixes in README.md
1 parent de1fdb7 commit f21e09a

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# swift-base64-kit
22

33
[![Swift 5.1](https://img.shields.io/badge/Swift-5.1-blue.svg)](https://swift.org/download/)
4-
[![github-actions](https://github.com/fabianfett/swift-base64-kit/workflows/CI/badge.svg)](https://github.com/fabianfett/swift-base64/actions)
4+
[![github-actions](https://github.com/fabianfett/swift-base64-kit/workflows/CI/badge.svg)](https://github.com/fabianfett/swift-base64-kit/actions)
55
[![codecov](https://codecov.io/gh/fabianfett/swift-base64-kit/branch/master/graph/badge.svg)](https://codecov.io/gh/fabianfett/swift-base64)
66
![macOS](https://img.shields.io/badge/os-macOS-green.svg?style=flat)
77
![tuxOS](https://img.shields.io/badge/os-tuxOS-green.svg?style=flat)
88

99

10-
This project provides a base64 encoder and decoder in pure Swift (without the use of Foundation). The implementation is [RFC4648](https://tools.ietf.org/html/rfc4648) complient.
10+
This package provides a base64 encoder and decoder in pure Swift (without the use of Foundation). The implementation is [RFC4648](https://tools.ietf.org/html/rfc4648) complient.
1111

12-
Today the implementation is rather simple. No fancy precomputed lookup tables, no fancy SIMD instructions. Therefore, there is definitely room for improvement performance wise. See also [Literature for a faster algorithm](#user-content-literature-for-a-faster-algorithm)
12+
Today the implementation is rather simple. No fancy precomputed lookup tables, no fancy SIMD instructions. Therefore, there is definitely room for improvement performance-wise. See also [Literature for a faster algorithm](#user-content-literature-for-a-faster-algorithm).
1313

1414
Everything began with [an issue](https://github.com/apple/swift-nio/issues/1265) on [`swift-nio`](https://github.com/apple/swift-nio).
1515

@@ -19,7 +19,6 @@ Everything began with [an issue](https://github.com/apple/swift-nio/issues/1265)
1919
- [x] faster than Foundation
2020
- [ ] decoding can ignore line breaks
2121
- [ ] encoding can insert line breaks
22-
- [ ] 100% test coverage
2322

2423
## Performance
2524

@@ -33,7 +32,7 @@ AAECAwQFBgcICQoLDA0ODxAREhMUFRYXGBkaGxwdHh8gISIjJCUmJygpKissLS4vMDEyMzQ1Njc4OTo7
3332
#### macOS
3433

3534
MacBook Pro (15-inch, late 2016 - the first one with the butterfly keyboard).
36-
Quad Core 2,7 GHz Intel Core i7
35+
Quad Core 2.7 GHz Intel Core i7
3736

3837
| | Encoding | Decoding |
3938
|:--|:--|:--|
@@ -55,7 +54,7 @@ I have no idea why Foundation base64 encoding is so slow on linux. 🤷‍♂️
5554

5655
## Literature for a faster algorithm
5756

58-
I would really like to speed up this project further to be way faster than it is today. Some food for thought of how this could be approached can be found here:
57+
I would really like to speed up this project further to be way faster than it is today. Some food for thought of how this could be tackled can be found here:
5958

6059
- [Chromium precomputed lookup tables](https://github.com/lemire/fastbase64/blob/master/src/chromiumbase64.c)
6160
- [Wojciech Muła, Daniel Lemire: Faster Base64 Encoding and Decoding using AVX2 Instructions](https://arxiv.org/pdf/1704.00605.pdf).
@@ -64,8 +63,7 @@ I would really like to speed up this project further to be way faster than it is
6463

6564
## Alternatives
6665

67-
As of today (2019-12-10) the author is only aware of two alternatives that both offer only encoding.
66+
As of today (2019-12-10), the author is aware of only one alternative that offers merely encoding.
6867

6968
- [SwiftyBase64](https://github.com/drichardson/SwiftyBase64)
70-
- [NIOWebSocket - Base64](https://github.com/apple/swift-nio/blob/master/Sources/NIOWebSocket/Base64.swift)
7169

0 commit comments

Comments
 (0)