Skip to content

Commit

Permalink
Polish repo
Browse files Browse the repository at this point in the history
  • Loading branch information
david-swift committed Oct 8, 2023
1 parent 4859244 commit d2f57b2
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 55 deletions.
3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@
/*.xcodeproj
xcuserdata/
DerivedData/
.swiftpm/config/registries.json
.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
.swiftpm/
.netrc
/Package.resolved
.Ulysses-Group.plist

This file was deleted.

80 changes: 35 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,9 @@ _SettingsKit_ makes it easier to add a settings window to a SwiftUI app for macO

## Table of Contents

- [Elements][1]
- [Installation][2]
- [Usage][3]
- [Thanks][4]

## Elements

| Name | Description |
| --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| Settings | A scene modifier for adding a settings window. |
| Settings Image Button Style | The button style of an image picker in the settings. |
| Settings Action | Contains a function for showing the settings window manually and another function for getting the active settings tab and subtabs selection. |
- [Installation][1]
- [Usage][2]
- [Thanks][3]

## Installation

Expand All @@ -54,48 +45,47 @@ _SettingsKit_ makes it easier to add a settings window to a SwiftUI app for macO

## Usage

An example app project is available [here.][5]
An example app project is available [here.][4]

* [Getting Started][6]
* [Getting Started][5]

### Usage

* [Add a Settings Window][7]
* [Tabs & Subtabs][8]
* [Actions][9]
* [Add a Settings Window][6]
* [Tabs & Subtabs][7]
* [Actions][8]

## Thanks

### Dependencies
- [SFSafeSymbols][10] licensed under the [MIT license][11]
- [SwiftLintPlugin][12] licensed under the [MIT license][13]
- [ColibriComponents][14] licensed under the [MIT license][15]
- [SFSafeSymbols][9] licensed under the [MIT license][10]
- [SwiftLintPlugin][11] licensed under the [MIT license][12]
- [ColibriComponents][13] licensed under the [MIT license][14]

### Other Thanks
- The [contributors][16]
- [SourceDocs][17] used for generating the [docs][18]
- [SwiftLint][19] for checking whether code style conventions are violated
- The programming language [Swift][20]

[1]: #elements
[2]: #installation
[3]: #usage
[4]: #thanks
[5]: /Tests/Examples/
[6]: user-manual/GettingStarted.md
[7]: user-manual/Usage/AddSettingsWindow.md
[8]: user-manual/Usage/TabsAndSubtabs.md
[9]: user-manual/Usage/Actions.md
[10]: https://github.com/SFSafeSymbols/SFSafeSymbols
[11]: https://github.com/SFSafeSymbols/SFSafeSymbols/blob/stable/LICENSE
[12]: https://github.com/lukepistrol/SwiftLintPlugin
[13]: https://github.com/lukepistrol/SwiftLintPlugin/blob/main/LICENSE
[14]: https://github.com/david-swift/ColibriComponents-macOS
[15]: https://github.com/david-swift/ColibriComponents-macOS/blob/main/LICENSE.md
[16]: Contributors.md
[17]: https://github.com/SourceDocs/SourceDocs
[18]: Documentation/Reference/SettingsKit-macOS/README.md
[19]: https://github.com/realm/SwiftLint
[20]: https://github.com/apple/swift
- The [contributors][15]
- [SourceDocs][16] used for generating the [docs][17]
- [SwiftLint][18] for checking whether code style conventions are violated
- The programming language [Swift][19]

[1]: #installation
[2]: #usage
[3]: #thanks
[4]: /Tests/Examples/
[5]: user-manual/GettingStarted.md
[6]: user-manual/Usage/AddSettingsWindow.md
[7]: user-manual/Usage/TabsAndSubtabs.md
[8]: user-manual/Usage/Actions.md
[9]: https://github.com/SFSafeSymbols/SFSafeSymbols
[10]: https://github.com/SFSafeSymbols/SFSafeSymbols/blob/stable/LICENSE
[11]: https://github.com/lukepistrol/SwiftLintPlugin
[12]: https://github.com/lukepistrol/SwiftLintPlugin/blob/main/LICENSE
[13]: https://github.com/david-swift/ColibriComponents-macOS
[14]: https://github.com/david-swift/ColibriComponents-macOS/blob/main/LICENSE.md
[15]: Contributors.md
[16]: https://github.com/SourceDocs/SourceDocs
[17]: Documentation/Reference/SettingsKit-macOS/README.md
[18]: https://github.com/realm/SwiftLint
[19]: https://github.com/apple/swift

[image-1]: Icons/GitHubBanner.png

0 comments on commit d2f57b2

Please sign in to comment.