Skip to content

Commit

Permalink
chore: Adds README to project again
Browse files Browse the repository at this point in the history
  • Loading branch information
daschaa committed Mar 28, 2024
1 parent fba419e commit da59f28
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 2 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,5 @@ jobs:
if: startsWith(github.ref, 'refs/tags/')
with:
files: |
billboard-x86_64.zip
billboard-arm64.zip
./**/billboard-x86_64.zip
./**/billboard-arm64.zip
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<h1 align="center">
πŸ“° Billboard
</h1>
<p align="center">
<strong>Put text on your Mac status bar</strong>
</p>
<p align="center">
<a href="https://github.com/daschaa/billboard/releases">
<img src="https://img.shields.io/github/v/release/daschaa/billboard" alt="Current build" />
</a>
<a href="https://github.com/daschaa/billboard/blob/main/LICENSE">
<img src="https://img.shields.io/github/license/daschaa/billboard" alt="Billboard is licensed under MIT" />
</a>
</p>

This is a little app that allows to put an user-defined text to the status bar of a Mac (the one on top).
## πŸ“Έ Screenshot

![Showcase](demo/demo.gif)

## πŸ’» Download

[The latest release can be downloaded here](https://github.com/daschaa/billboard/releases). Currently the app is not signed, but it is on the open task list.

## πŸ‘― Contributing

Any contributions are highly welcomed. If you have any ideas, please create an issue before creating an pull-request. Thanks in advance ❀️

## πŸ§‘πŸΌβ€πŸ’» Local Development

Feel free to checkout the repo and hack some stuff on your own! ❀️

#### 🚫 "Help! I ran into some issue!"
Arrrgh. I swear it runs on my machine πŸ‘€ But just open up an issue and we'll try to fix the issue together. Please try to provide as many details as you can.
Binary file added demo/demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit da59f28

Please sign in to comment.