Skip to content

Commit

Permalink
docs: Update of Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
steilerDev committed Jul 3, 2023
1 parent b9e8fcd commit a34373a
Showing 1 changed file with 24 additions and 13 deletions.
37 changes: 24 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,17 +29,6 @@
</a>
</p>
<hr>
<p align="center">
<a href="https://github.com/steilerDev/icloud-photos-sync/actions/workflows/api-test.yml">
<img alt="API Status" src="https://img.shields.io/github/actions/workflow/status/steilerDev/icloud-photos-sync/api-test.yml?branch=main&label=API%20Status&style=for-the-badge&logo=githubactions&logoColor=white">
</a>
<a href="https://github.com/steilerDev/icloud-photos-sync/actions/workflows/dev-release.yml">
<img alt="Development Release Status" src="https://img.shields.io/github/actions/workflow/status/steilerDev/icloud-photos-sync/dev-release.yml?branch=dev&label=Dev%20Release&style=for-the-badge&logo=githubactions&logoColor=white">
</a>
<a href="https://github.com/steilerDev/icloud-photos-sync/actions/workflows/prod-release.yml">
<img alt="Production Release Status" src="https://img.shields.io/github/actions/workflow/status/steilerDev/icloud-photos-sync/prod-release.yml?branch=v1.1.0&label=Prod%20Release&style=for-the-badge&logo=githubactions&logoColor=white">
</a>
</p>
<p align="center">
<a href="https://steilerdev.github.io/icloud-photos-sync/dev/coverage/">
<img alt="Test Coverage (Lines)" src="https://img.shields.io/badge/dynamic/json?color=success&label=Coverage%20%28Lines%29&style=for-the-badge&logo=jest&logoColor=white&query=%24.total.lines.pct&suffix=%25&url=https%3A%2F%2Fsteilerdev.github.io%2Ficloud-photos-sync%2Fdev%2Fcoverage%2Fcoverage-summary.json">
Expand All @@ -48,6 +37,11 @@
<img alt="Test Coverage (Functions)" src="https://img.shields.io/badge/dynamic/json?color=success&label=Coverage%20%28Functions%29&style=for-the-badge&logo=jest&logoColor=white&query=%24.total.functions.pct&suffix=%25&url=https%3A%2F%2Fsteilerdev.github.io%2Ficloud-photos-sync%2Fdev%2Fcoverage%2Fcoverage-summary.json">
</a>
</p>
<p align="center">
<a href="https://github.com/steilerDev/icloud-photos-sync/blob/main/CODE_OF_CONDUCT.md">
<img alt="Code of Conduct" src="https://img.shields.io/badge/Contributor_Covenant-2.1-blue?style=for-the-badge">
</a>
</p>
<hr>

## Overview
Expand Down Expand Up @@ -136,6 +130,23 @@ As this application is using an undocumented public API, there are a couple of k

## Contributing & Feedback

Please re-try the sync a couple of times before reporting an issue. The application will reload from the filesystem and therefore recover from "corrupted" states. After that, check [known issues](https://github.com/steilerDev/icloud-photos-sync/labels/known%20issue) before [opening an issue](https://github.com/steilerDev/icloud-photos-sync/issues/new?assignees=&labels=open&template=issue-template.md&title=). Always [enable crash and error reporting](https://steilerdev.github.io/icloud-photos-sync/user-guides/error-reporting/), so this crash and all required technical details are recorded and reported.
Please check the [contributing guidelines](https://github.com/steilerDev/icloud-photos-sync/blob/main/CONTRIBUTING.md) to learn how to engage with this project.

Pull requests are always welcomed! Please open them against the `dev` branch for quick consideration. I tried to make this codebase as maintainable and automated as possible, in order to make future releases and contributions quick and easy, while ensuring functionality. This includes [unit](https://steilerdev.github.io/icloud-photos-sync/dev/coverage/), [API](https://github.com/steilerDev/icloud-photos-sync/actions/workflows/api-test.yml) & [E2E](https://github.com/steilerDev/icloud-photos-sync/tree/main/docker/test) tests.
### Workflow Status

<p align="center">
<a href="https://github.com/steilerDev/icloud-photos-sync/actions/workflows/event_push.yml">
<img alt="Nightly Release Status" src="https://img.shields.io/github/actions/workflow/status/steilerDev/icloud-photos-sync/event_push.yml?branch=dev&label=Nightly&style=for-the-badge&logo=githubactions&logoColor=white">
</a>
<a href="https://github.com/steilerDev/icloud-photos-sync/actions/workflows/event_push.yml">
<img alt="Beta Release Status" src="https://img.shields.io/github/actions/workflow/status/steilerDev/icloud-photos-sync/event_push.yml?branch=beta&label=Beta&style=for-the-badge&logo=githubactions&logoColor=white">
</a>
<a href="https://github.com/steilerDev/icloud-photos-sync/actions/workflows/event_push.yml">
<img alt="Production Release Status" src="https://img.shields.io/github/actions/workflow/status/steilerDev/icloud-photos-sync/event_push.yml?branch=main&label=Production&style=for-the-badge&logo=githubactions&logoColor=white">
</a>
</p>
<p align="center">
<a href="https://github.com/steilerDev/icloud-photos-sync/actions/workflows/monitor_api.yml">
<img alt="API Status" src="https://img.shields.io/github/actions/workflow/status/steilerdev/icloud-photos-sync/monitor_api.yml?branch=main&event=schedule&style=for-the-badge&logo=githubactions&logoColor=white&label=API%20Status">
</a>
</p>

0 comments on commit a34373a

Please sign in to comment.