Skip to content

Commit

Permalink
Docs: Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
YassineLafryhi committed Aug 17, 2024
1 parent a011869 commit 4d76bec
Show file tree
Hide file tree
Showing 7 changed files with 17 additions and 12 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
> A tool for checking spelling in Swift code
![](https://img.shields.io/badge/license-MIT-brown)
![](https://img.shields.io/badge/version-0.9.5-orange)
![](https://img.shields.io/badge/version-0.9.6-orange)
![](https://img.shields.io/badge/SwiftSyntax-508.0.1-purple)
![](https://img.shields.io/badge/Yams-5.0.6-red)
![](https://img.shields.io/badge/Commander-0.9.1-green)
Expand Down Expand Up @@ -34,6 +34,7 @@ sudo chmod +x /usr/local/bin/swiftyspell
> `SwiftySpell` supports the same languages as the `NSSpellChecker` class from AppKit. To see the list of supported languages, run the following command: `swiftyspell languages`.
Configure SwiftySpell by running `swiftyspell init` command inside the project folder, then edit the generated `.swiftyspell.yml` configuration file.

This is an example of the configuration file:

```yml
Expand Down Expand Up @@ -82,11 +83,11 @@ fi
```
![](Screenshots/Screenshot1.png)

An example of the warnings displayed in Xcode:
Some examples of the warnings displayed in Xcode:

| Warnings on the Editor area | Warnings on the Issue Navigator |
|----------------------------------|----------------------------------|
| ![](Screenshots/Screenshot2.png) | ![](Screenshots/Screenshot3.png) |
|----------------------------------|----------------------------------|
| ![](Screenshots/Screenshot4.png) | ![](Screenshots/Screenshot5.png) |

### Command Line
Run SwiftySpell from the command line by navigating to the directory containing the Swift project you want to check and running the following command:
Expand Down
Binary file modified Screenshots/Screenshot2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Screenshots/Screenshot3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Screenshots/Screenshot4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Screenshots/Screenshot5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions SwiftySpell.podspec
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
Pod::Spec.new do |s|
s.name = 'SwiftySpell'
s.version = "0.9.5"
s.version = "0.9.6"
s.summary = 'A tool for checking spelling in Swift code.'
s.homepage = 'https://github.com/YassineLafryhi/SwiftySpell'
s.license = { type: 'MIT', file: 'LICENSE.txt' }
s.author = { 'Yassine Lafryhi' => '[email protected]' }
s.source = { http: "https://github.com/YassineLafryhi/SwiftySpell/releases/download/0.9.5/SwiftySpell-v0.9.5.zip" }
s.source = { http: "https://github.com/YassineLafryhi/SwiftySpell/releases/download/0.9.6/SwiftySpell-v0.9.6.zip" }
s.preserve_paths = 'SwiftySpell'
s.platforms = { ios: '12.0', osx: '11.0' }
s.requires_arc = false
Expand Down
16 changes: 10 additions & 6 deletions SwiftySpell.xcodeproj/project.pbxproj
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,15 @@
C204C5D62C6BE1020093E216 /* .swiftformat */ = {isa = PBXFileReference; lastKnownFileType = text; path = .swiftformat; sourceTree = "<group>"; };
C204C5D72C6BE1140093E216 /* .periphery.yml */ = {isa = PBXFileReference; lastKnownFileType = text; path = .periphery.yml; sourceTree = "<group>"; };
C204C5DB2C6BF0710093E216 /* TestExample.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TestExample.swift; sourceTree = "<group>"; };
C2A7AE6A2C711E00001B3E3D /* Screenshot1.png */ = {isa = PBXFileReference; lastKnownFileType = image.png; path = Screenshot1.png; sourceTree = "<group>"; };
C2A7AE6B2C711E00001B3E3D /* Screenshot2.png */ = {isa = PBXFileReference; lastKnownFileType = image.png; path = Screenshot2.png; sourceTree = "<group>"; };
C2A7AE6C2C711E00001B3E3D /* Screenshot3.png */ = {isa = PBXFileReference; lastKnownFileType = image.png; path = Screenshot3.png; sourceTree = "<group>"; };
C2A7AE6D2C711E00001B3E3D /* Screenshot4.png */ = {isa = PBXFileReference; lastKnownFileType = image.png; path = Screenshot4.png; sourceTree = "<group>"; };
C2A7AE6E2C711E00001B3E3D /* Screenshot5.png */ = {isa = PBXFileReference; lastKnownFileType = image.png; path = Screenshot5.png; sourceTree = "<group>"; };
C2B894012B865B62001C10FA /* SwiftySpell.podspec */ = {isa = PBXFileReference; lastKnownFileType = text; path = SwiftySpell.podspec; sourceTree = SOURCE_ROOT; };
C2EF5D2D2B83CB7400112859 /* SwiftySpell */ = {isa = PBXFileReference; explicitFileType = "compiled.mach-o.executable"; includeInIndex = 0; path = SwiftySpell; sourceTree = BUILT_PRODUCTS_DIR; };
C2EF5D302B83CB7400112859 /* main.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = main.swift; sourceTree = "<group>"; };
C2EF5D6F2B83D87200112859 /* README.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = README.md; sourceTree = "<group>"; };
C2EF5D722B83F61B00112859 /* Screenshot1.png */ = {isa = PBXFileReference; lastKnownFileType = image.png; path = Screenshot1.png; sourceTree = "<group>"; };
C2EF5D732B83F61B00112859 /* Screenshot2.png */ = {isa = PBXFileReference; lastKnownFileType = image.png; path = Screenshot2.png; sourceTree = "<group>"; };
C2EF5D742B83F61B00112859 /* Screenshot3.png */ = {isa = PBXFileReference; lastKnownFileType = image.png; path = Screenshot3.png; sourceTree = "<group>"; };
C2F684EE2C67E91D00D39246 /* LICENSE.txt */ = {isa = PBXFileReference; lastKnownFileType = text; path = LICENSE.txt; sourceTree = "<group>"; };
C2F684EF2C68109B00D39246 /* SwiftySpellCodeVisitor.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SwiftySpellCodeVisitor.swift; sourceTree = "<group>"; };
C2F684F12C6810CB00D39246 /* SwiftySpellChecker.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SwiftySpellChecker.swift; sourceTree = "<group>"; };
Expand Down Expand Up @@ -138,9 +140,11 @@
C2EF5D712B83F61B00112859 /* Screenshots */ = {
isa = PBXGroup;
children = (
C2EF5D722B83F61B00112859 /* Screenshot1.png */,
C2EF5D732B83F61B00112859 /* Screenshot2.png */,
C2EF5D742B83F61B00112859 /* Screenshot3.png */,
C2A7AE6A2C711E00001B3E3D /* Screenshot1.png */,
C2A7AE6B2C711E00001B3E3D /* Screenshot2.png */,
C2A7AE6C2C711E00001B3E3D /* Screenshot3.png */,
C2A7AE6D2C711E00001B3E3D /* Screenshot4.png */,
C2A7AE6E2C711E00001B3E3D /* Screenshot5.png */,
);
path = Screenshots;
sourceTree = "<group>";
Expand Down

0 comments on commit 4d76bec

Please sign in to comment.