Skip to content

Commit 53a9480

Browse files
committed
Small updates to README
1 parent 0ac48ae commit 53a9480

1 file changed

Lines changed: 15 additions & 15 deletions

File tree

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ A framework with (de)compression algorithms and functions for working with vario
99

1010
## What is this?
1111

12-
SWCompression — is a framework with a collection of functions for:
12+
SWCompression is a framework with a collection of functions for:
1313

1414
1. Decompression (and sometimes compression) using different algorithms.
1515
2. Reading (and sometimes writing) archives of different formats.
@@ -33,7 +33,7 @@ Also, SWCompression is _written with Swift only._
3333

3434
## Installation
3535

36-
SWCompression can be integrated into your project using Swift Package Manager, CocoaPods or Carthage.
36+
SWCompression can be integrated into your project using Swift Package Manager, CocoaPods, or Carthage.
3737

3838
### Swift Package Manager
3939

@@ -46,7 +46,7 @@ let package = Package(
4646
name: "PackageName",
4747
dependencies: [
4848
.package(url: "https://github.com/tsolomko/SWCompression.git",
49-
from: "4.5.0")
49+
from: "4.6.0")
5050
],
5151
targets: [
5252
.target(
@@ -61,7 +61,7 @@ More details you can find in [Swift Package Manager's Documentation](https://git
6161

6262
### CocoaPods
6363

64-
Add `pod 'SWCompression', '~> 4.5'` and `use_frameworks!` lines to your Podfile.
64+
Add `pod 'SWCompression', '~> 4.6'` and `use_frameworks!` lines to your Podfile.
6565

6666
To complete installation, run `pod install`.
6767

@@ -104,19 +104,17 @@ BZip2 and LZMA/LZMA2 support).
104104

105105
### Carthage
106106

107-
__Important:__ Only Swift 5.x is supported when installing SWCompression via Carthage.
108-
109-
Add to your Cartfile `github "tsolomko/SWCompression" ~> 4.5`.
107+
Add to your Cartfile `github "tsolomko/SWCompression" ~> 4.6`.
110108

111109
Then:
112110

113-
1. If you use Xcode 12 or later you should run `carthage update --use-xcframeworks --no-use-binaries`. After that drag
114-
and drop both `SWCompression.xcframework` and `BitByteData.xcframework` files from from the `Carthage/Build/` directory
115-
into the "Frameworks, Libraries, and Embedded Content" section of your target's "General" tab in Xcode.
111+
1. If you use Xcode 12 or later you should run `carthage update --use-xcframeworks`. After that drag and drop both
112+
`SWCompression.xcframework` and `BitByteData.xcframework` files from from the `Carthage/Build/` directory into the
113+
"Frameworks, Libraries, and Embedded Content" section of your target's "General" tab in Xcode.
116114

117-
2. If you use Xcode 11 or earlier you should run `carthage update --no-use-binaries`. After that drag and drop both
118-
`SWCompression.framework` and `BitByteData.framework` files from from the `Carthage/Build/<platform>/` directory into the
119-
"Embedded Binaries" section of your target's "General" tab in Xcode.
115+
2. If you use Xcode 11 or earlier you should run `carthage update`. After that drag and drop both
116+
`SWCompression.framework` and `BitByteData.framework` files from from the `Carthage/Build/<platform>/` directory into
117+
the "Embedded Binaries" section of your target's "General" tab in Xcode.
120118

121119
For Xcode 12 or later you can currently also use the
122120
[xconfig workaround](https://github.com/Carthage/Carthage/blob/master/Documentation/Xcode12Workaround.md).
@@ -164,7 +162,8 @@ do {
164162
### Documentation
165163

166164
Every function or type of SWCompression's public API is documented. This documentation can be found at its own
167-
[website](http://tsolomko.github.io/SWCompression).
165+
[website](http://tsolomko.github.io/SWCompression) or via a slightly shorter link:
166+
[swcompression.tsolomko.me](http://swcompression.tsolomko.me)
168167

169168
### Sophisticated example
170169

@@ -174,7 +173,8 @@ you need to uncomment several lines in "Package.swift" and run `swift build -c r
174173
## Contributing
175174

176175
Whether you find a bug, have a suggestion, idea, feedback or something else, please
177-
[create an issue](https://github.com/tsolomko/SWCompression/issues) on GitHub.
176+
[create an issue](https://github.com/tsolomko/SWCompression/issues) on GitHub. If you have any questions, you can ask
177+
them on the [Discussions](https://github.com/tsolomko/SWCompression/discussions) page.
178178

179179
In the case of a bug, it will be especially helpful if you attach a file (archive, etc.) that caused the bug to occur.
180180

0 commit comments

Comments
 (0)