Skip to content

Commit

Permalink
Updating readmes (#208)
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Dec 7, 2023
1 parent 5b60079 commit 55fb826
Showing 1 changed file with 31 additions and 15 deletions.
46 changes: 31 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
<p align="center">
<img src="https://github.com/fastybird/.github/blob/main/assets/repo_title.png?raw=true" alt="FastyBird"/>
</p>

# FastyBird IoT triggers module

[![Build Status](https://badgen.net/github/checks/FastyBird/triggers-module/main?cache=300&style=flat-square)](https://github.com/FastyBird/triggers-module/actions)
[![Licence](https://badgen.net/github/license/FastyBird/triggers-module?cache=300&style=flat-square)](https://github.com/FastyBird/triggers-module/blob/main/LICENSE.md)
[![Code coverage](https://badgen.net/coveralls/c/github/FastyBird/triggers-module?cache=300&style=flat-square)](https://coveralls.io/r/FastyBird/triggers-module)
[![Build Status](https://img.shields.io/github/actions/workflow/status/FastyBird/triggers-module/ci.yaml?style=flat-square)](https://github.com/FastyBird/triggers-module/actions)
[![Licence](https://img.shields.io/github/license/FastyBird/triggers-module?style=flat-square)](https://github.com/FastyBird/triggers-module/blob/main/LICENSE.md)
[![Code coverage](https://img.shields.io/coverallsCoverage/github/FastyBird/triggers-module?style=flat-square)](https://coveralls.io/r/FastyBird/triggers-module)
[![Mutation testing](https://img.shields.io/endpoint?style=flat-square&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2FFastyBird%2Ftriggers-module%2Fmain)](https://dashboard.stryker-mutator.io/reports/github.com/FastyBird/triggers-module/main)

![PHP](https://badgen.net/packagist/php/FastyBird/triggers-module?cache=300&style=flat-square)
[![PHP latest stable](https://badgen.net/packagist/v/FastyBird/triggers-module/latest?cache=300&style=flat-square)](https://packagist.org/packages/FastyBird/triggers-module)
[![PHP downloads total](https://badgen.net/packagist/dt/FastyBird/triggers-module?cache=300&style=flat-square)](https://packagist.org/packages/FastyBird/triggers-module)
[![PHPStan](https://img.shields.io/badge/phpstan-enabled-brightgreen.svg?style=flat-square)](https://github.com/phpstan/phpstan)
[![Latest stable](https://badgen.net/packagist/v/FastyBird/triggers-module/latest?cache=300&style=flat-square)](https://packagist.org/packages/FastyBird/triggers-module)
[![Downloads total](https://badgen.net/packagist/dt/FastyBird/triggers-module?cache=300&style=flat-square)](https://packagist.org/packages/FastyBird/triggers-module)
[![PHPStan](https://img.shields.io/badge/PHPStan-enabled-brightgreen.svg?style=flat-square)](https://github.com/phpstan/phpstan)

![JS](https://img.shields.io/badge/js-es6-blue.svg?style=flat-square)
[![JS latest stable](https://badgen.net/npm/v/@fastybird/triggers-module?cache=300&style=flat-square)](https://www.npmjs.com/package/@fastybird/triggers-module)
Expand All @@ -20,10 +24,6 @@
Triggers module is a [FastyBird](https://www.fastybird.com) [IoT](https://en.wikipedia.org/wiki/Internet_of_things)
extension for managing automation & notifications.

[FastyBird](https://www.fastybird.com) [IoT](https://en.wikipedia.org/wiki/Internet_of_things) triggers module is
an [Apache2 licensed](http://www.apache.org/licenses/LICENSE-2.0) distributed extension, developed
in [PHP](https://www.php.net) on top of the [Nette framework](https://nette.org) and [Symfony framework](https://symfony.com) and in [Typescript](https://www.typescriptlang.org) on top of the [Vue framework](https://vuejs.org).

### Features:

- Triggers and their actions and conditions management
Expand All @@ -33,6 +33,10 @@ in [PHP](https://www.php.net) on top of the [Nette framework](https://nette.org)
- User interface integration via [Vue 3](https://vuejs.org) components
- Integrated automator worker for PHP based automators

[FastyBird](https://www.fastybird.com) [IoT](https://en.wikipedia.org/wiki/Internet_of_things) triggers module is
an [Apache2 licensed](http://www.apache.org/licenses/LICENSE-2.0) distributed extension, developed
in [PHP](https://www.php.net) on top of the [Nette framework](https://nette.org) and [Symfony framework](https://symfony.com) and in [Typescript](https://www.typescriptlang.org) on top of the [Vue framework](https://vuejs.org).

## Requirements

PHP part of [FastyBird](https://www.fastybird.com) triggers module is tested against PHP 8.1.
Expand Down Expand Up @@ -65,6 +69,22 @@ npm install @fastybird/triggers-module
Learn how to configure and use triggers module and manage your automation & notifications
in [documentation](https://github.com/FastyBird/triggers-module/blob/main/docs/index.md).

# FastyBird

<p align="center">
<img src="https://github.com/fastybird/.github/blob/main/assets/fastybird_row.svg?raw=true" alt="FastyBird"/>
</p>

FastyBird is an Open Source IOT solution built from decoupled components with powerful API and the highest quality code. Read more on [fastybird.com.com](https://www.fastybird.com).

## Documentation

Documentation is available on [docs.fastybird.com](https://docs.fastybird.com).

## Contributing

The sources of this package are contained in the [FastyBird monorepo](https://github.com/FastyBird/fastybird). We welcome contributions for this package on [FastyBird/fastybird](https://github.com/FastyBird/).

## Feedback

Use the [issue tracker](https://github.com/FastyBird/fastybird/issues) for bugs
Expand All @@ -77,18 +97,14 @@ Thank you for testing, reporting and contributing.

For release info check [release page](https://github.com/FastyBird/fastybird/releases).

## Contribute

The sources of this package are contained in the [FastyBird monorepo](https://github.com/FastyBird/fastybird). We welcome contributions for this package on [FastyBird/fastybird](https://github.com/FastyBird/).

## Maintainers

<table>
<tbody>
<tr>
<td align="center">
<a href="https://github.com/akadlec">
<img width="80" height="80" src="https://avatars3.githubusercontent.com/u/1866672?s=460&amp;v=4">
<img alt="akadlec" width="80" height="80" src="https://avatars3.githubusercontent.com/u/1866672?s=460&amp;v=4" />
</a>
<br>
<a href="https://github.com/akadlec">Adam Kadlec</a>
Expand Down

0 comments on commit 55fb826

Please sign in to comment.