Skip to content

Commit 7f86b22

Browse files
authored
docs: update README.MD (#181)
1 parent 06d65c4 commit 7f86b22

File tree

1 file changed

+69
-6
lines changed

1 file changed

+69
-6
lines changed

README.MD

Lines changed: 69 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
</div>
88
<div align="center">
99

10-
[![npm version](https://img.shields.io/npm/v/react-native-image-marker.svg?logo=npm&style=for-the-badge&label=latest)](https://www.npmjs.com/package/react-native-image-marker)
10+
[![npm version](https://img.shields.io/npm/v/react-native-image-marker.svg?logo=npm&style=for-the-badge&label=latest)](https://www.npmjs.com/package/react-native-image-marker)
1111
[![npm](https://img.shields.io/npm/dm/react-native-image-marker?logo=npm&style=for-the-badge)](https://www.npmjs.com/package/react-native-image-marker) [![npm](https://img.shields.io/npm/dt/react-native-image-marker.svg?cacheSeconds=88660&logo=npm&label=total%20downloads&style=for-the-badge)](https://www.npmjs.com/package/react-native-image-marker)
1212
[![stars](https://img.shields.io/github/stars/jimmydaddy/react-native-image-marker?logo=github&style=for-the-badge)](https://github.com/JimmyDaddy/react-native-image-marker) [![forks](https://img.shields.io/github/forks/jimmydaddy/react-native-image-marker?logo=github&style=for-the-badge)](https://github.com/JimmyDaddy/react-native-image-marker/fork)
1313
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?logo=github&style=for-the-badge)](https://github.com/JimmyDaddy/react-native-image-marker/pulls) ![license](https://img.shields.io/npm/l/react-native-image-marker?style=for-the-badge)
@@ -19,11 +19,75 @@
1919
</div>
2020

2121
---
22+
2223
> * If this library is useful to you, please give me a ⭐️. 🤩
2324
> * If there is any bug, please submit an issue 🐛, or create a pull request 🤓.
2425
> * If there is any problem about using this library, please contact me, or [open a QA discussion](https://github.com/JimmyDaddy/react-native-image-marker/discussions/categories/q-a). 🤔
26+
2527
---
2628

29+
<!-- toc -->
30+
31+
* [Features](#features)
32+
* [Sample](#sample)
33+
* [Usage](#usage)
34+
* [Text background fit](#text-background-fit)
35+
* [API](#api)
36+
* [Sample](#sample-1)
37+
* [Example](#example)
38+
* [Text background stretchX](#text-background-stretchx)
39+
* [API](#api-1)
40+
* [Sample](#sample-2)
41+
* [Example](#example-1)
42+
* [Text background stretchY](#text-background-stretchy)
43+
* [API](#api-2)
44+
* [Sample](#sample-3)
45+
* [Example](#example-2)
46+
* [Text background border radius](#text-background-border-radius)
47+
* [API](#api-3)
48+
* [Sample](#sample-4)
49+
* [Example](#example-3)
50+
* [Text with shadow](#text-with-shadow)
51+
* [API](#api-4)
52+
* [Sample](#sample-5)
53+
* [Example](#example-4)
54+
* [Multiple text watermarks](#multiple-text-watermarks)
55+
* [Sample](#sample-6)
56+
* [Example](#example-5)
57+
* [Text rotation](#text-rotation)
58+
* [Sample](#sample-7)
59+
* [Example](#example-6)
60+
* [Icon watermarks](#icon-watermarks)
61+
* [Sample](#sample-8)
62+
* [Example](#example-7)
63+
* [Multiple icon watermarks](#multiple-icon-watermarks)
64+
* [API](#api-5)
65+
* [Sample](#sample-9)
66+
* [Example](#example-8)
67+
* [Background rotation](#background-rotation)
68+
* [Sample](#sample-10)
69+
* [Example](#example-9)
70+
* [Icon rotation](#icon-rotation)
71+
* [Sample](#sample-11)
72+
* [Example](#example-10)
73+
* [Transparent background](#transparent-background)
74+
* [Sample](#sample-12)
75+
* [Example](#example-11)
76+
* [Transparent icon](#transparent-icon)
77+
* [Sample](#sample-13)
78+
* [Example](#example-12)
79+
* [Compatibility](#compatibility)
80+
* [Installation](#installation)
81+
* [iOS Pod Install (RN version < 0.60.0)](#ios-pod-install-rn-version--0600)
82+
* [API](#api-6)
83+
* [Save image to file](#save-image-to-file)
84+
* [Contributors](#contributors)
85+
* [Examples](#examples)
86+
* [Contributing](#contributing)
87+
* [License](#license)
88+
89+
<!-- tocstop -->
90+
2791
## Features
2892

2993
* [Add **multiple text** watermarks to images](https://jimmydaddy.github.io/react-native-image-marker/interfaces/TextMarkOptions.html#watermarkTexts)
@@ -65,7 +129,6 @@
65129

66130
#### Example
67131

68-
69132
```typescript
70133
import Marker, { Position, TextBackgroundType } from "react-native-image-marker"
71134
···
@@ -76,7 +139,7 @@ const options = {
76139
scale: 1,
77140
},
78141
watermarkTexts: [{
79-
text: 'text marker \n multline text',
142+
text: 'text marker \n multiline text',
80143
positionOptions: {
81144
position: Position.topLeft,
82145
},
@@ -128,7 +191,7 @@ const options = {
128191
scale: 1,
129192
},
130193
watermarkTexts: [{
131-
text: 'text marker \n multline text',
194+
text: 'text marker \n multiline text',
132195
positionOptions: {
133196
position: Position.topLeft,
134197
},
@@ -179,7 +242,7 @@ const options = {
179242
scale: 1,
180243
},
181244
watermarkTexts: [{
182-
text: 'text marker \n multline text',
245+
text: 'text marker \n multiline text',
183246
positionOptions: {
184247
position: Position.topLeft,
185248
},
@@ -292,7 +355,7 @@ const options = {
292355
scale: 1,
293356
},
294357
watermarkTexts: [{
295-
text: 'text marker \n multline text',
358+
text: 'text marker \n multiline text',
296359
positionOptions: {
297360
position: Position.topLeft,
298361
},

0 commit comments

Comments
 (0)