Skip to content

Commit 26775d6

Browse files
committed
Update README
1 parent ed93d8c commit 26775d6

1 file changed

Lines changed: 13 additions & 12 deletions

File tree

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# BitByteData
22

33
[![Swift 4.2](https://img.shields.io/badge/Swift-4.2-blue.svg)](https://developer.apple.com/swift/)
4-
[![Swift 5.X](https://img.shields.io/badge/Swift-5.X-blue.svg)](https://developer.apple.com/swift/)
4+
[![Swift 5.X](https://img.shields.io/badge/Swift-/5.X-blue.svg)](https://developer.apple.com/swift/)
55
[![GitHub license](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/tsolomko/BitByteData/master/LICENSE)
66
[![Build Status](https://travis-ci.com/tsolomko/BitByteData.svg?branch=develop)](https://travis-ci.com/tsolomko/BitByteData)
77

@@ -13,8 +13,7 @@ BitByteData can be integrated into your project using Swift Package Manager, Coc
1313

1414
### Swift Package Manager
1515

16-
To install using SPM, add BitByteData to you package dependencies
17-
and specify it as a dependency for your target, e.g.:
16+
To install using SPM, add BitByteData to you package dependencies and specify it as a dependency for your target, e.g.:
1817

1918
```swift
2019
import PackageDescription
@@ -38,18 +37,20 @@ More details you can find in [Swift Package Manager's Documentation](https://git
3837

3938
### CocoaPods
4039

41-
Add `pod 'BitByteData', '~> 1.4'` and `use_frameworks!` to your Podfile.
40+
Add `pod 'BitByteData', '~> 1.4'` and `use_frameworks!` lines to your Podfile.
4241

4342
To complete installation, run `pod install`.
4443

4544
### Carthage
4645

46+
__Important:__ Only Swift 5.x is supported when installing BitByteData via Carthage.
47+
4748
Add to your Cartfile `github "tsolomko/BitByteData" ~> 1.4`.
4849

4950
Then run `carthage update`.
5051

51-
Finally, drag and drop `BitByteData.framework` from `Carthage/Build` folder
52-
into the "Embedded Binaries" section on your targets' "General" tab in Xcode.
52+
Finally, drag and drop `BitByteData.framework` from `Carthage/Build` folder into the "Embedded Binaries" section on your
53+
targets' "General" tab in Xcode.
5354

5455
## Usage
5556

@@ -62,8 +63,8 @@ Both `LsbBitReader` and `MsbBitReader` classes inherit from `ByteReader` so you
6263
Writing bits is implemented in two classes `LsbBitWriter` and `MsbBitWriter` (again, for two bit-numbering schemes).
6364
They both conform to `BitWriter` protocol.
6465

65-
__Note:__ All readers and writers aren't structs, but classes intentionally.
66-
This is done to make it easier to pass them as arguments to functions and to eliminate unnecessary copying and `inout`s.
66+
__Note:__ All readers and writers aren't structs, but classes intentionally to make it easier to pass them as arguments
67+
to functions and to eliminate unnecessary copying and `inout`s.
6768

6869
## Documentation
6970

@@ -72,10 +73,10 @@ This documentation can be found at its own [website](http://tsolomko.github.io/B
7273

7374
## Contributing
7475

75-
Whether you find a bug, have a suggestion, idea or something else,
76-
please [create an issue](https://github.com/tsolomko/BitByteData/issues) on GitHub.
76+
Whether you find a bug, have a suggestion, idea, feedback or something else, please
77+
[create an issue](https://github.com/tsolomko/BitByteData/issues) on GitHub.
7778

78-
If you'd like to contribute code, please [create a pull request](https://github.com/tsolomko/BitByteData/pulls) on GitHub.
79+
If you'd like to contribute, please [create a pull request](https://github.com/tsolomko/BitByteData/pulls) on GitHub.
7980

8081
__Note:__ If you are considering working on BitByteData, please note that Xcode project (BitByteData.xcodeproj)
8182
was created manually and you shouldn't use `swift package generate-xcodeproj` command.
@@ -93,4 +94,4 @@ If you are considering contributing to the project please make sure that:
9394
regressions are small and such performance tradeoff is necessary and justifiable.
9495

9596
Finally, please note that any meaningful comparison can be made only between benchmarks run on the same hardware and
96-
software system.
97+
software.

0 commit comments

Comments
 (0)