Skip to content

Commit 1b11f4c

Browse files
authored
chore: update readme file (#6)
2 parents 84ba259 + 59ae2aa commit 1b11f4c

File tree

1 file changed

+27
-7
lines changed

1 file changed

+27
-7
lines changed

README.md

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,35 @@
1-
# In App Review Service
1+
# <p align="center">In App Review Service</p>
22

3+
<div align="center">
4+
5+
[![in_app_review_service][build_status_badge]][workflow_link]
6+
![coverage][coverage_badge]
37
[![style: very good analysis][very_good_analysis_badge]][very_good_analysis_link]
48
[![Powered by Mason](https://img.shields.io/endpoint?url=https%3A%2F%2Ftinyurl.com%2Fmason-badge)](https://github.com/felangel/mason)
5-
[![License: MIT][license_badge]][license_link]
9+
[![License: Apache 2.0][license_badge]][license_link]
10+
11+
</div>
612

7-
In App Review Service
13+
This service wraps the [in_app_review][in_app_review_link] and provides secure usage of the plugin by handling exceptions.
814

915
## Installation 💻
1016

1117
**❗ In order to start using In App Review Service you must have the [Flutter SDK][flutter_install_link] installed on your machine.**
1218

13-
Install via `flutter pub add`:
19+
Add `in_app_review_service` to your `pubspec.yaml`:
20+
21+
```yaml
22+
dependencies:
23+
in_app_review_service:
24+
git:
25+
url: https://github.com/BBKDevelopment/In-App-Review-Service.git
26+
ref: v1.0.0
27+
```
28+
29+
Install it:
1430
1531
```sh
16-
dart pub add in_app_review_service
32+
flutter packages get
1733
```
1834

1935
---
@@ -50,10 +66,14 @@ genhtml coverage/lcov.info -o coverage/
5066
open coverage/index.html
5167
```
5268

69+
[in_app_review_link]: https://github.com/britannio/in_app_review
70+
[workflow_link]: https://github.com/BBKDevelopment/In-App-Review-Service/actions/workflows/main.yaml
71+
[build_status_badge]: https://github.com/BBKDevelopment/In-App-Review-Service/actions/workflows/main.yaml/badge.svg
72+
[coverage_badge]: coverage_badge.svg
5373
[flutter_install_link]: https://docs.flutter.dev/get-started/install
5474
[github_actions_link]: https://docs.github.com/en/actions/learn-github-actions
55-
[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg
56-
[license_link]: https://opensource.org/licenses/MIT
75+
[license_badge]: https://img.shields.io/badge/License-Apache%202.0-blue.svg
76+
[license_link]: https://opensource.org/licenses/Apache-2.0
5777
[logo_black]: https://raw.githubusercontent.com/VGVentures/very_good_brand/main/styles/README/vgv_logo_black.png#gh-light-mode-only
5878
[logo_white]: https://raw.githubusercontent.com/VGVentures/very_good_brand/main/styles/README/vgv_logo_white.png#gh-dark-mode-only
5979
[mason_link]: https://github.com/felangel/mason

0 commit comments

Comments
 (0)