Skip to content

Commit

Permalink
Updated
Browse files Browse the repository at this point in the history
  • Loading branch information
kevoj committed Jan 26, 2020
1 parent 3a0f4da commit ef34abb
Showing 1 changed file with 22 additions and 22 deletions.
44 changes: 22 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# react-native-background-shapes

[![NPM version](https://badge.fury.io/js/react-native-backgroud-shapes.svg)](https://npmjs.org/package/react-native-backgroud-shapes) [![GitHub license](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](https://raw.githubusercontent.com/kevoj/react-native-backgroud-shapes/master/LICENSE)
Expand All @@ -7,33 +6,32 @@
### Examples

![Imgur -fullwidth](https://imgur.com/Dzkd0zB.jpg)

<img src="https://imgur.com/Dzkd0zB.jpg" width="400" >
<img src="https://imgur.com/i7YfOxK.jpg" width="400" >
<img src="https://imgur.com/m2f78nl.jpg" width="400" >
<img src="https://imgur.com/dNwUJV2.jpg" width="400" >
<img align="right" src="https://imgur.com/Dzkd0zB.jpg" width="400" >
<img align="right" src="https://imgur.com/i7YfOxK.jpg" width="400" >
<img align="right" src="https://imgur.com/m2f78nl.jpg" width="400" >
<img align="right" src="https://imgur.com/dNwUJV2.jpg" width="400" >

<!-- ![Imgur](https://imgur.com/Dzkd0zB.jpg)
![Imgur](https://imgur.com/i7YfOxK.jpg)
![Imgur](https://imgur.com/m2f78nl.jpg)
![Imgur](https://imgur.com/dNwUJV2.jpg) -->

img[alt$="-fullwidth"]{
width: 100%;
display: block;
}

### Installation

**Yarn**

```bash
yarn add react-native-background-shapes
```

**Npm**

```bash
npm i react-native-background-shapes
```

### Usage

```javascript
import react from "react";
import {View} from "react-native";
Expand All @@ -47,13 +45,14 @@ return (
);
}
```

### Options

```javascript
// Basic
<Shapes />
// Advance
<Shapes
<Shapes
primaryColor="#416DF8"
secondaryColor="#2F53D5"
height={3}
Expand All @@ -65,15 +64,16 @@ return (
]}
/>
```
* **primaryColor**: String, HEX color.
* **secondaryColor**: String, HEX color.
* **height**: Number, 1 = full screen, default (3.5)
* **borderRadius**: Number, default 30
* **figures**: Array
* * **name**: String = "circle","donut, "triangle", "diamondNarrow", "cutDiamond"
* * **position**: String = "flex-start", "center, "flex-end", "baseline", "stretch"
* * **axis**: String = "top", "right, "bottom", "left"

- **primaryColor**: String, HEX color.
- **secondaryColor**: String, HEX color.
- **height**: Number, 1 = full screen, default (3.5)
- **borderRadius**: Number, default 30
- **figures**: Array
- - **name**: String = "circle","donut, "triangle", "diamondNarrow", "cutDiamond"
- - **position**: String = "flex-start", "center, "flex-end", "baseline", "stretch"
- - **axis**: String = "top", "right, "bottom", "left"

## License

MIT © [Leonardo Rico](https://github.com/kevoj/react-native-background-shapes/blob/master/LICENSE)
MIT © [Leonardo Rico](https://github.com/kevoj/react-native-background-shapes/blob/master/LICENSE)

0 comments on commit ef34abb

Please sign in to comment.