Skip to content

Commit

Permalink
Updat readme badges, wording around discord
Browse files Browse the repository at this point in the history
  • Loading branch information
mattmassicotte committed Feb 20, 2024
1 parent 451449e commit 9d65be9
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
<div align="center">

[![Build Status][build status badge]][build status]
[![Documentation][documentation badge]][documentation]
[![Discord][discord badge]][discord]

</div>

# Chime
An editor for macOS

Expand Down Expand Up @@ -31,7 +39,7 @@ Chime used to be commercial, but is now free. It built up some pretty significan

It is always a good idea to **discuss** before taking on a significant task. That said, I have a strong bias towards enthusiasm. If you are excited about doing something, I'll do my best to get out of your way.

The project is [internally documented](Edit/Chime.docc) with [DocC](https://www.swift.org/documentation/docc/#). The docs contains details about getting started, structure, and internal systems/behaviors.
The project is [internally documented][documentation] with [DocC](https://www.swift.org/documentation/docc/#). The docs contains details about getting started, structure, and internal systems/behaviors. A [Discord server][discord] is also available for live help, but GitHub issues/discussions is preferred.

There are a few areas that would make for excellent targets though, if you really feel so inclined.

Expand Down Expand Up @@ -89,3 +97,9 @@ Chime is a reasonably complex project. It's bound to run into bugs in Apple fram

[download]: https://www.chimehq.com/download
[chimekit]: https://github.com/ChimeHQ/ChimeKit
[build status]: https://github.com/ChimeHQ/Chime/actions
[build status badge]: https://github.com/ChimeHQ/Chime/workflows/CI/badge.svg
[documentation]: Edit/Chime.docc
[documentation badge]: https://img.shields.io/badge/Documentation-DocC-blue
[discord]: https://discord.gg/esFpX6sErJ
[discord badge]: https://img.shields.io/badge/Discord-purple?logo=Discord&label=Chat&color=%235A64EC

0 comments on commit 9d65be9

Please sign in to comment.