Skip to content

Commit

Permalink
Update readme (#42)
Browse files Browse the repository at this point in the history
* chore: 🤖 add shield badges

* chore: 🤖 add google play button

* Create _config.yml

* docs: ✏️ add logo to readme
  • Loading branch information
ricky9667 authored Jul 17, 2024
1 parent 5c1086f commit c9b3cb8
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 4 deletions.
36 changes: 32 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,35 @@
# HUSH Keyboard
<h1 align="center">HUSH Keyboard</h1>

<p align="center">
<a href="https://github.com/ricky9667/HushKeyboard/releases">
<img alt="Release" src="https://img.shields.io/github/v/release/ricky9667/HushKeyboard?display_name=tag&style=flat-square">
</a>
<a href="https://app.codecov.io/gh/ricky9667/HushKeyboard">
<img alt="Codecov" src="https://img.shields.io/codecov/c/github/ricky9667/HushKeyboard?style=flat-square">
</a>
<a href="https://github.com/ricky9667/HushKeyboard/blob/update-readme/LICENSE">
<img alt="GitHub License" src="https://img.shields.io/github/license/ricky9667/HushKeyboard?style=flat-square">
</a>
</p>

<p align="center">
<img src="./assets/logo.png" width=300>
</p>

## Introduction

Typing Rubik's Cube notations on a mobile keyboard kind of a frustration, switching between notations, numbers, and symbols makes it extremely annoying.
HUSH Keyboard provides a specialized Rubik's Cube keyboard that is functional, minimal, and customizable.
Typing Rubik's Cube notations on a mobile keyboard kind of a frustration, switching between
notations, numbers, and symbols makes it extremely annoying.
HUSH Keyboard provides a specialized Rubik's Cube keyboard that is functional, minimal, and
customizable.

By the way,

**HUSH Keyboard is live on Google Play!**

<a href="https://play.google.com/store/apps/details?id=com.rickyhu.hushkeyboard">
<img width=200 src="./assets/google_play_store_button.webp" alt="Google Play">
</a>

## Features

Expand All @@ -15,4 +41,6 @@ HUSH Keyboard provides a specialized Rubik's Cube keyboard that is functional, m

## License

This project is licensed under the GPL license (version 3 or later). This means that this library is free to use, although you must publish any code that uses it (e.g. also put it on GitHub). See the [full license](https://github.com/ricky9667/HushKeyboard/blob/master/LICENSE) for exact details.
This project is licensed under the GPL license (version 3 or later). This means that this library is
free to use, although you must publish any code that uses it (e.g. also put it on GitHub). See
the [full license](https://github.com/ricky9667/HushKeyboard/blob/master/LICENSE) for exact details.
1 change: 1 addition & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
remote_theme: pages-themes/tactile@v0.2.0
Binary file added assets/google_play_store_button.webp
Binary file not shown.
Binary file added assets/logo.png
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 c9b3cb8

Please sign in to comment.