Skip to content

Commit

Permalink
Merge pull request #167 from inson1/patch-1
Browse files Browse the repository at this point in the history
Nicer Readme 1.0
  • Loading branch information
CrazyMarvin authored Dec 31, 2023
2 parents ff73863 + 441f669 commit 53d86fb
Showing 1 changed file with 34 additions and 11 deletions.
45 changes: 34 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,36 @@
[![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/Crazy-Marvin/Flashy/CI/development)](https://github.com/Crazy-Marvin/Flashy/actions)
[![License](https://img.shields.io/github/license/Crazy-Marvin/Flashy.svg)](https://github.com/Crazy-Marvin/Flashy/blob/development/LICENSE)
<div align="center">

<img width="200" src="https://github.com/Crazy-Marvin/Flashy/blob/development/fastlane/metadata/android/en-US/images/icon.png" alt="Flashy icon" align="center">
# Flashy

### Simple & Privacy-Friendly Flashlight App

[![Last commit](https://img.shields.io/github/last-commit/Crazy-Marvin/Flashy.svg?style=flat)](https://github.com/Crazy-Marvin/Flashy/commits)
[![Releases](https://img.shields.io/github/downloads/Crazy-Marvin/Flashy/total.svg?style=flat)](https://github.com/Crazy-Marvin/Flashy/releases)
[![Latest tag](https://img.shields.io/github/tag/Crazy-Marvin/Flashy.svg?style=flat)](https://github.com/Crazy-Marvin/Flashy/tags)
[![Downloads](https://img.shields.io/github/downloads/Crazy-Marvin/Flashy/total.svg?style=flat)](https://github.com/Crazy-Marvin/Flashy/releases)
[![API](https://img.shields.io/badge/API-19%2B-brightgreen.svg?style=flat)](https://android-arsenal.com/api?level=19)
[![License](https://img.shields.io/github/license/Crazy-Marvin/Flashy.svg)](https://github.com/Crazy-Marvin/Flashy/blob/development/LICENSE)

[![Issues](https://img.shields.io/github/issues/Crazy-Marvin/Flashy.svg?style=flat)](https://github.com/Crazy-Marvin/Flashy/issues)
[![Pull requests](https://img.shields.io/github/issues-pr/Crazy-Marvin/Flashy.svg?style=flat)](https://github.com/Crazy-Marvin/Flashy/pulls)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/379c59381e784f42b5910864e574bd8e)](https://www.codacy.com/gh/Crazy-Marvin/Flashy?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=Crazy-Marvin/Flashy&amp;utm_campaign=Badge_Grade)
[![codecov](https://codecov.io/gh/Crazy-Marvin/Flashy/branch/master/graph/badge.svg)](https://codecov.io/gh/Crazy-Marvin/Flashy)
[![Translation status](https://hosted.weblate.org/widgets/flashy/-/svg-badge.svg)](https://hosted.weblate.org/engage/flashy/)

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/379c59381e784f42b5910864e574bd8e)](https://www.codacy.com/gh/Crazy-Marvin/Flashy?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=Crazy-Marvin/Flashy&amp;utm_campaign=Badge_Grade)
[![Known Vulnerabilities](https://snyk.io/test/github/Crazy-Marvin/Flashy/badge.svg?targetFile=app%2Fbuild.gradle)](https://snyk.io/test/github/Crazy-Marvin/Flashy?targetFile=app%2Fbuild.gradle)
[![API](https://img.shields.io/badge/API-19%2B-brightgreen.svg?style=flat)](https://android-arsenal.com/api?level=19)
[![F-Droid](https://img.shields.io/f-droid/v/rocks.poopjournal.flashy.svg)](https://f-droid.org/en/packages/rocks.poopjournal.flashy/)
[![Google Play](https://badgen.net/badge/icon/googleplay?icon=googleplay&label)](https://play.google.com/store/apps/details?id=rocks.poopjournal.flashy)
[![codecov](https://codecov.io/gh/Crazy-Marvin/Flashy/branch/master/graph/badge.svg)](https://codecov.io/gh/Crazy-Marvin/Flashy)

# Flashy
<a href="https://f-droid.org/en/packages/rocks.poopjournal.flashy">
<img alt="Get it on F-Droid" src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" height="100">
</a>
<a href="https://play.google.com/store/apps/details?id=rocks.poopjournal.flashy">
<img alt="Get it on Google Play" src="https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png" height="100">
</a>
<a href="https://github.com/Crazy-Marvin/Flashy/releases/latest">
<img alt="Get it on GitHub" src="https://raw.githubusercontent.com/deckerst/common/main/assets/get-it-on-github.png" height="100">
</a>

</div>

<b>Flashy</b> is a simple and practical <b>screen flashlight app</b> that uses your screen’s light or camera flash and converts your phone and tablet in a powerful flashlight. Enjoy a handy bright flashlight at your reach anytime and anywhere you need it.

Expand All @@ -37,7 +54,7 @@ This fast flashlight can be a perfect choice for users with a device that doesn
* Uses your screen’s light or camera flash as a source
* Control and customize the brightness

# Contributing
# 🔨 Contributing

The ```development``` or a feature branch is used while developing the code, and pushed into the master branch ```trunk``` afterwards for releases.
PRs to the ```trunk``` need at least one approving review before getting merged.
Expand All @@ -50,6 +67,12 @@ Please make sure to update tests as appropriate.

Check out the [contribution guidelines](https://github.com/Crazy-Marvin/Flashy/blob/trunk/.github/CONTRIBUTING.md) for details please.

# License
# 📜 License

[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0)

# 💙 Contributors

<a href="https://github.com/Crazy-Marvin/Flashy/graphs/contributors">
<img alt="List of contributors to this repository" src="https://contrib.rocks/image?repo=Crazy-Marvin/Flashy" />
</a>

0 comments on commit 53d86fb

Please sign in to comment.