@@ -11,11 +11,13 @@ react-store-badges is a React.js component displaying badges for App Store and G
1111react-store-badge uses SVG files, (optimized by svgo) so no worries about image going wrong.
1212
1313## Getting started
14+
1415```
1516 npm install --save react-store-badges
1617```
1718
1819## Usage
20+
1921```
2022 import React, {Component} from 'react'
2123
@@ -40,29 +42,40 @@ react-store-badge uses SVG files, (optimized by svgo) so no worries about image
4042 }
4143```
4244
45+ ## props
46+
47+ | Name | Type | Default | Description |
48+ | :----------- | :-------------------------------: | :--------: | :------------------------------ |
49+ | ** url** | <code >string</code > | ` required ` | url of App Store and Play Store |
50+ | ** platform** | <code >'ios'| ; 'android'</code > | ` required ` | url of App Store and Play Store |
51+ | ** defaultLocale** | <code >string</code > | 'en-us' | default locale code |
52+ | ** locale** | <code >string</code > | 'en-us' | locale name |
53+ | ** width** | <code >number</code > | 135 | width for badge size |
54+ | ** height** | <code >number</code > | 40 | height for badge size |
55+ | ** target** | <code >'_ self'| ; '_ blank'| ; '_ parent'| ; '_ top'</code > | '_ self' | target for url to be opened |
4356## Localization
57+
4458### Supported locales
59+
4560[ Apple locales list] ( https://www.apple.com/itunes/marketing-on-itunes/identity-guidelines.html#itunes-store-badges#LocalizedBadges )
4661
4762[ Google locales list] ( https://github.com/yjb94/google-play-badge-svg/tree/master/img )
4863
4964### Localization tip
65+
5066- iOS uses full code of their locale. (ex. en-us) and google uses short code of their locale(ex. en). So if you want your badge in only one store, you can customize it anyway.
5167
5268## Badge Guidelines
69+
5370please note that you have to follow the guidelines below
5471
5572[ Apple Badge Guidelines] ( https://developer.apple.com/app-store/marketing/guidelines/ )
5673
5774[ Google Badge Guidelines] ( https://play.google.com/intl/en_us/badges/ )
5875
59-
60-
6176[ build-badge ] : https://img.shields.io/travis/yjb94/react-store-badge/master.png?style=flat-square
6277[ build ] : https://travis-ci.org/yjb94/react-store-badge
63-
6478[ npm-badge ] : https://img.shields.io/npm/v/npm-package.png?style=flat-square
6579[ npm ] : https://www.npmjs.org/package/npm-package
66-
6780[ coveralls-badge ] : https://img.shields.io/coveralls/yjb94/react-store-badges/master.png?style=flat-square
6881[ coveralls ] : https://coveralls.io/github/yjb94/react-store-badges
0 commit comments