Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ludufre committed Nov 7, 2021
1 parent 669fa28 commit 9439960
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 22 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2021 Quéau Jean Pierre

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
53 changes: 32 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,44 @@
# capacitor-screenshot
<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">Screenshot</h3>
<p align="center"><strong><code>capacitor-screenshot</code></strong></p>
<p align="center">
Capacitor community plugin for take screenshot.
</p>

This plugin take screenshot of the app
<p align="center">
<img src="https://img.shields.io/maintenance/yes/2021?style=flat-square" />
<a href="https://github.com/ludufre/capacitor-screenshot/actions?query=workflow%3A%22CI%22"><img src="https://img.shields.io/github/workflow/status/ludufre/capacitor-screenshot/CI?style=flat-square" /></a>
<a href="https://www.npmjs.com/package/capacitor-screenshot"><img src="https://img.shields.io/npm/l/capacitor-screenshot?style=flat-square" /></a>
<br>
<a href="https://www.npmjs.com/package/capacitor-screenshot"><img src="https://img.shields.io/npm/dw/capacitor-screenshot?style=flat-square" /></a>
<a href="https://www.npmjs.com/package/capacitor-screenshot"><img src="https://img.shields.io/npm/v/capacitor-screenshot?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 -->
</p>

## Install
## Maintainers

```bash
npm install capacitor-screenshot
npx cap sync
```

## API
| Maintainer | GitHub | Social |
| ---------------------- | ------------------------------------- | --------------------------------------- |
| Luan Freitas (ludufre) | [ludufre](https://github.com/ludufre) | [@ludufre](https://twitter.com/ludufre) |

<docgen-index>
## Installation

* [`take()`](#take)
`npm install capacitor-screenshot`

</docgen-index>
## Configuration

<docgen-api>
<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
Not needed.

### take()
## Usage

```typescript
take() => any
```
import { Screenshot } from 'capacitor-screenshot';

**Returns:** <code>any</code>
...

--------------------

</docgen-api>
Screenshot.take().then((ret: { base64: string }) => {
console.log(ret.base64); // or `data:image/png;base64,${ret.base64}`
});
```
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"android/build.gradle",
"dist/",
"ios/Plugin/",
"CapacitorPluginScreenshot.podspec"
"CapacitorScreenshot.podspec"
],
"author": "Luan Freitas (ludufre)",
"license": "MIT",
Expand Down

0 comments on commit 9439960

Please sign in to comment.