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 91fd2b6 commit ea41ffe
Showing 1 changed file with 29 additions and 13 deletions.
42 changes: 29 additions & 13 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 Couch DB plugin

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

![PHP](https://badgen.net/packagist/php/FastyBird/couchdb-plugin?cache=300&style=flat-square)
[![PHP latest stable](https://badgen.net/packagist/v/FastyBird/couchdb-plugin/latest?cache=300&style=flat-square)](https://packagist.org/packages/FastyBird/couchdb-plugin)
[![PHP downloads total](https://badgen.net/packagist/dt/FastyBird/couchdb-plugin?cache=300&style=flat-square)](https://packagist.org/packages/FastyBird/couchdb-plugin)
[![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/couchdb-plugin/latest?cache=300&style=flat-square)](https://packagist.org/packages/FastyBird/couchdb-plugin)
[![Downloads total](https://badgen.net/packagist/dt/FastyBird/couchdb-plugin?cache=300&style=flat-square)](https://packagist.org/packages/FastyBird/couchdb-plugin)
[![PHPStan](https://img.shields.io/badge/PHPStan-enabled-brightgreen.svg?style=flat-square)](https://github.com/phpstan/phpstan)

***

Expand All @@ -18,14 +22,14 @@ Couch DB plugin is extension for [FastyBird](https://www.fastybird.com) [IoT](ht
which is implementing [Couch](https://couch.io) states manager for reading
and setting application state.

Couch DB plugin 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).

### Features

- Application state management for reading and storing states in Couch database
- Implemented sync and async Couch client

Couch DB plugin 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).

## Installation

The best way to install **fastybird/couchdb-plugin** is using [Composer](http://getcomposer.org/):
Expand All @@ -39,6 +43,22 @@ composer require fastybird/couchdb-plugin
Learn how to read & write states and consume & publish messages
in [documentation](https://github.com/FastyBird/couchdb-plugin/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 @@ -51,10 +71,6 @@ 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>
Expand Down

0 comments on commit ea41ffe

Please sign in to comment.