Skip to content

Commit eda1f77

Browse files
authored
refactor: improving the readme for version 0.9.0 (#170)
* feat: add icon for readme * refactor: adjustment readme header Updated README to include additional badges and improve project description. * refactor: update readme Updated badge links and improved formatting in README.
1 parent 65acfa8 commit eda1f77

File tree

2 files changed

+35
-15
lines changed

2 files changed

+35
-15
lines changed

README.md

Lines changed: 35 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,45 @@
1-
# spm-swift-package
2-
3-
[![CI](https://github.com/heroesofcode/spm-swift-package/actions/workflows/CI.yml/badge.svg)](https://github.com/heroesofcode/spm-swift-package/actions/workflows/CI.yml)
4-
[![Crates.io](https://img.shields.io/crates/v/spm-swift-package)](https://crates.io/crates/spm-swift-package)
5-
[![License](https://img.shields.io/github/license/heroesofcode/spm-swift-package.svg)](https://github.com/heroesofcode/spm-swift-package/blob/main/LICENSE)
6-
7-
Command Line Tools for macOS to create project in Swift Package Manager with desirable files.
8-
9-
- ✅ Supports iOS, macOS, tvOS, watchOS, and visionOS
10-
- ✅ Can generate files such as Changelog, Swift Package Index, and SwiftLint
11-
- ✅ SwiftLint automatically generates a swiftlint.yml file using the [SwiftLintPlugin](https://github.com/lukepistrol/SwiftLintPlugin)
12-
- ✅ Xcode 26.0 compatibility
13-
- ❌ Not compatible with earlier Xcode versions
1+
<p align="center">
2+
<img src="./assets/icon.webp" width="300" />
3+
<br>
4+
5+
<a href="https://github.com/heroesofcode/spm-swift-package/releases">
6+
<img src="https://img.shields.io/github/v/release/heroesofcode/spm-swift-package?style=flat&labelColor=1C2C2E&color=C96329&logo=GitHub&logoColor=white" /></a>
7+
8+
<a href="https://crates.io/crates/spm-swift-package">
9+
<img src="https://img.shields.io/crates/v/spm-swift-package?style=flat&labelColor=1C2C2E&color=C96329&logo=Rust&logoColor=white" /></a>
10+
11+
<a href="https://github.com/heroesofcode/spm-swift-package/actions/workflows/CI.yml">
12+
<img src="https://img.shields.io/github/actions/workflow/status/heroesofcode/spm-swift-package/CI.yml?style=flat&labelColor=1C2C2E&label=CI&color=BEC5C9&logo=GitHub%20Actions&logoColor=BEC5C9" /></a>
13+
14+
<a href="https://github.com/heroesofcode/spm-swift-package/actions/workflows/Release.yml">
15+
<img src="https://img.shields.io/github/actions/workflow/status/heroesofcode/spm-swift-package/Release.yml?style=flat&labelColor=1C2C2E&color=BEC5C9&label=deploy&logo=GitHub%20Actions&logoColor=BEC5C9" /></a>
16+
17+
<a href="https://github.com/heroesofcode/spm-swift-package/blob/main/LICENSE">
18+
<img src="https://img.shields.io/badge/license-MIT-BEC5C9?style=flat&labelColor=1C2C2E&logoColor=BEC5C9" /></a>
19+
</p>
20+
21+
<p align="center">
22+
<strong>Command Line Tools for macOS to create Swift Package Manager projects with desirable files.</strong>
23+
</p>
24+
25+
## Features
26+
27+
- 🚀 **Multi-platform:** iOS • macOS • tvOS • watchOS • visionOS
28+
- 🛠️ **Auto-generated files:** Changelog • Readme • Swift Package Index • SwiftLint
29+
-**SwiftLint integration:** Generates `.swiftlint.yml` using the [SwiftLintPlugin](https://github.com/lukepistrol/SwiftLintPlugin)
30+
- 🧰 **Modern toolchain:** Compatible with Xcode 26.0
31+
- ⚠️ **No legacy support:** Does not work with older Xcode versions
1432

1533
## Installing
1634

17-
#### Cargo
35+
#### Cargo 🦀
1836
Installing from [crates.io](https://crates.io/) (requires Rust/Cargo):
1937

2038
```shell
2139
cargo install spm-swift-package
2240
```
2341

24-
#### Homebrew
42+
#### Homebrew 🍻
2543
You can install with [Homebrew](https://brew.sh/):
2644

2745
```shell
@@ -31,6 +49,8 @@ brew install heroesofcode/taps/spm-swift-package
3149

3250
## Usage
3351

52+
Run the command to start creating your Swift Package Manager:
53+
3454
```sh
3555
spm-swift-package
3656
```

assets/icon.webp

8.21 KB
Loading

0 commit comments

Comments
 (0)