Skip to content

Commit 8fb5253

Browse files
committed
docs: add helpful links and badges
1 parent dd8d3da commit 8fb5253

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

.github/workflows/main.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ jobs:
6767

6868
cd:
6969
name: Build and Publish
70-
if: (github.event_name == 'push' && needs.ci.outputs.release) || (github.event_name == 'workflow_dispatch' && github.event.inputs.release)
70+
if: (github.event_name == 'push' && needs.ci.outputs.release == 'true') || (github.event_name == 'workflow_dispatch' && github.event.inputs.release == 'true')
7171
needs: ci
7272
runs-on: ubuntu-latest
7373

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,22 @@
11
# cocoapods-embed-flutter
22

3+
[![CI/CD](https://github.com/DartBuild/cocoapods-embed-flutter/actions/workflows/main.yml/badge.svg?branch=main&event=push)](https://github.com/DartBuild/cocoapods-embed-flutter/actions/workflows/main.yml)
34
[![Gem Version](https://badge.fury.io/rb/cocoapods-embed-flutter.svg)](http://badge.fury.io/rb/cocoapods-embed-flutter)
4-
<!--- [![Code Climate](https://codeclimate.com/github/DartBuild/cocoapods-embed-flutter.png)](https://codeclimate.com/github/DartBuild/cocoapods-embed-flutter) -->
5+
[![Code Climate](https://codeclimate.com/github/DartBuild/cocoapods-embed-flutter.png)](https://codeclimate.com/github/DartBuild/cocoapods-embed-flutter)
56

67
Straight forward way of declaring flutter modules as dependency for targets, just like cocoapods does with pods.
78

89
## Installation
910

11+
### Install using command line.
1012
```bash
1113
$ [sudo] gem install cocoapods-embed-flutter
1214
```
1315

16+
### Or add this to your `Gemfile`.
17+
```rb
18+
gem 'cocoapods-embed-flutter'
19+
```
1420
## Usage
1521

1622
In your host project `Podfile`, write the below line before any target definition
@@ -33,3 +39,12 @@ pub 'flutter_module', :git => 'https://github.com/gowalla/flutter_module.git', :
3339
pub 'flutter_module', :git => 'https://github.com/gowalla/flutter_module.git', :tag => '0.7.0'
3440
pub 'flutter_module', :git => 'https://github.com/gowalla/flutter_module.git', :commit => '082f8319af'
3541
```
42+
43+
## Links
44+
45+
| Link | Description |
46+
| :----- | :------ |
47+
[Gem page](https://rubygems.org/gems/cocoapods-embed-flutter) | Official Ruby Gems page.
48+
[Code docs](https://www.rubydoc.info/gems/cocoapods-embed-flutter) | Generated code documentation.
49+
[Changelog](https://github.com/DartBuild/cocoapods-embed-flutter/blob/main/CHANGELOG.md) | See the changes introduced in each version.
50+
[Code of Conduct](CODE_OF_CONDUCT.md) | Find out the standards we hold ourselves to.

0 commit comments

Comments
 (0)