Skip to content

Commit 6e99471

Browse files
Update README (#73)
* Skip installing swiftlint * Update readme, remove contributing guidelines * Create CONTRIBUTING.md Co-authored-by: Andrew Glaze <[email protected]>
1 parent 636cc33 commit 6e99471

File tree

2 files changed

+26
-23
lines changed

2 files changed

+26
-23
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Contributing
2+
3+
Thank you for popping by! If you know the Discord API well,
4+
have Swift knowledge, and feel like contributing, feel free to
5+
make a pull request! Any (positive) contribution is welcome,
6+
no matter how small! You can also join the Swiftcord Discord server
7+
to discuss improvements and bug fixes!
8+
9+
Found an issue? Ensure it isn't a duplicate, then open a new issue
10+
with the appropriate template and fill in the placeholders as
11+
clearly as you can. Responding promptly to follow-up comments
12+
is appreciated, as debugging is hard without any further input
13+
from the OP.
14+
15+
Want to translate Swiftcord into another language? Head on over to our [Weblate](https://hosted.weblate.org/projects/swiftcord/swiftcord/)!

README.md

Lines changed: 11 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
1-
<image src="Swiftcord/Assets.xcassets/AppIcon.appiconset/app-256.png" width="128px" height="128px" align="left" />
1+
<p align="center"><image src="Swiftcord/Assets.xcassets/AppIcon.appiconset/Picture 1.png" width="196px" height="196px" /></p>
22

3-
# Swiftcord
4-
A completely native Discord client for macOS built 100% in Swift and SwiftUI
3+
<h1 align="center">Swiftcord</h1>
4+
<p align="center">A completely native Discord client for macOS built 100% in Swift and SwiftUI</p>
55

6-
![Viewing the general-talk channel in the r/MacBookPro server in Swiftcord](README_Resources/heroScreenshot.png)
6+
<image src="README_Resources/heroScreenshot.png" width="100%" alt="Viewing the general-talk channel in the r/MacBookPro server in Swiftcord" />
77

88
[![Lines of code](https://img.shields.io/tokei/lines/github/SwiftcordApp/Swiftcord?style=for-the-badge)]()
99
[![Discord](https://img.shields.io/discord/964741354112577557?color=rgb%2888%2C101%2C242%29&label=discord&style=for-the-badge)](https://discord.gg/he7n6MGDXS)
1010
[![GitHub Repo stars](https://img.shields.io/github/stars/cryptoAlgorithm/Swiftcord?color=%23FECF0F&style=for-the-badge)](https://github.com/SwiftcordApp/Swiftcord/stargazers)
1111
[![GitHub Sponsors](https://img.shields.io/github/sponsors/cryptoAlgorithm?label=buy%20me%20a%20coffee&logo=buymeacoffee&style=for-the-badge)](https://github.com/sponsors/cryptoAlgorithm)
1212
[![Weblate project translated](https://img.shields.io/weblate/progress/swiftcord?style=for-the-badge)](https://hosted.weblate.org/projects/swiftcord/swiftcord/)
1313

14+
---
15+
1416
This project aims to create a fully functional native Discord
1517
client in Swift for macOS from scratch.
1618

@@ -21,14 +23,14 @@ the Discord API implementation Swiftcord relies on.
2123
me to continue developing it**
2224

2325
**Consider buying me a coffee ☕️ by sponsoring Swiftcord!**
26+
![image](https://user-images.githubusercontent.com/64193267/178003528-eaea4288-ce49-468b-a838-12616441237f.png)
2427

2528
## Contents
2629
* [Motivation](#motivation)
2730
* [Releases](#releases)
2831
* [FAQ](#faq)
2932
* [Current State](#current-state)
3033
* [Roadmap](#roadmap)
31-
* [Contributions](#contributions) - Read this before contributing
3234
* [Copyright Notice](#copyright-notice)
3335

3436
---
@@ -61,6 +63,10 @@ Alpha releases are available at [GitHub Releases](https://github.com/cryptoAlgor
6163
Swiftcord is also available on homebrew as a cask: `brew install swiftcord`. Versions are
6264
lock stepped with alpha releases on GitHub releases.
6365

66+
### TestFlight
67+
68+
Coming soon!
69+
6470
<!-- todo: Add building from source -->
6571

6672
### Requirements
@@ -169,24 +175,6 @@ and they may not necessarily be implemented in sequence.
169175

170176
---
171177

172-
## Contributions
173-
174-
Thank you for popping by! If you know the Discord API well,
175-
have Swift knowledge, and feel like contributing, feel free to
176-
make a pull request! Any (positive) contribution is welcome,
177-
no matter how small! You can also join the Swiftcord Discord server
178-
to discuss improvements and bug fixes!
179-
180-
Found an issue? Ensure it isn't a duplicate, then open a new issue
181-
with the appropriate template and fill in the placeholders as
182-
clearly as you can. Responding promptly to follow-up comments
183-
is appreciated, as debugging is hard without any further input
184-
from the OP.
185-
186-
Want to translate Swiftcord into another language? Head on over to our [Weblate.](https://hosted.weblate.org/projects/swiftcord/swiftcord/)
187-
188-
---
189-
190178
## Copyright Notice
191179

192180
Copyright (c) 2022 Vincent Kwok

0 commit comments

Comments
 (0)