Skip to content

Commit

Permalink
docs: update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
robsonos committed Dec 18, 2023
1 parent ba1c480 commit 6f4d7f5
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 11 deletions.
4 changes: 4 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"projectName": "<insert the repo's name>",
"projectOwner": "<insert the repo's owner/orgs>"
}
48 changes: 37 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,34 @@
<p align="center"><br><img src="https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png" width="128" height="128" /></p>
<h3 align="center">Nordic DFU</h3>
<p align="center"><strong><code>@capacitor-community/nordic-dfu</code></strong></p>
<p align="center"><strong><code>capacitor-community-nordic-dfu</code></strong></p>
<p align="center">
Capacitor plugin to interface with Nordic DFU's <a href="https://github.com/NordicSemiconductor/IOS-DFU-Library">IOS-DFU-Library</a> and <a href="https://github.com/NordicSemiconductor/Android-DFU-Library">Android-DFU-Library</a>.
</p>

<p align="center">
<img src="https://img.shields.io/maintenance/yes/2020?style=flat-square" />
<a href="https://github.com/capacitor-community/example/actions?query=workflow%3A%22CI%22"><img src="https://img.shields.io/github/workflow/status/capacitor-community/example/CI?style=flat-square" /></a>
<a href="https://www.npmjs.com/package/@capacitor-community/example"><img src="https://img.shields.io/npm/l/@capacitor-community/example?style=flat-square" /></a>
<br>
<a href="https://www.npmjs.com/package/@capacitor-community/example"><img src="https://img.shields.io/npm/dw/@capacitor-community/example?style=flat-square" /></a>
<a href="https://www.npmjs.com/package/@capacitor-community/example"><img src="https://img.shields.io/npm/v/@capacitor-community/example?style=flat-square" /></a>
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
<a href="#contributors-"><img src="https://img.shields.io/badge/all%20contributors-0-orange?style=flat-square" /></a>
<!-- ALL-CONTRIBUTORS-BADGE:END -->
<img src="https://img.shields.io/maintenance/yes/2023?style=flat-square" />
<a href="https://github.com/robsonos/nordic-dfu/actions/workflows/ci.yaml"
><img
alt="GitHub Workflow Status (with event)"
src="https://img.shields.io/github/actions/workflow/status/robsonos/nordic-dfu/ci.yaml"
/></a>
<a href="https://www.npmjs.com/package/capacitor-community-nordic-dfu"
><img src="https://img.shields.io/npm/l/capacitor-community-nordic-dfu?style=flat-square"
/></a>
<br />
<a href="https://www.npmjs.com/package/capacitor-community-nordic-dfu"
><img
alt="Downloads from npmjs"
src="https://img.shields.io/npm/dw/capacitor-community-nordic-dfu?style=flat-square"
/></a>
<a href="https://www.npmjs.com/package/capacitor-community-nordic-dfu"
><img alt="Version from npmjs" src="https://img.shields.io/npm/v/capacitor-community-nordic-dfu?style=flat-square"
/></a>
<a href="#contributors"
><img
alt="GitHub contributors from allcontributors.org"
src="https://img.shields.io/github/all-contributors/robsonos/nordic-dfu"
/></a>
</p>

## Table of Contents
Expand All @@ -23,6 +37,7 @@
- [Installation](#installation)
- [Permissions](#permissions)
- [API](#api)
- [Contributors](#contributors)

## Maintainers

Expand All @@ -33,7 +48,7 @@
## Installation

```bash
npm install @capacitor-community/nordic-dfu
npm install capacitor-community-nordic-dfu
npx cap sync
```

Expand Down Expand Up @@ -261,3 +276,14 @@ Contains data related to the DFU update process, such as progress and speed.
| **`DFU_FAILED`** | <code>'DFU_FAILED'</code> | The DFU process has failed. | 1.0.0 |

</docgen-api>

## Contributors

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

0 comments on commit 6f4d7f5

Please sign in to comment.