Skip to content

Commit

Permalink
docs: add helpful links and badges
Browse files Browse the repository at this point in the history
  • Loading branch information
soumyamahunt committed Mar 12, 2022
1 parent dd8d3da commit 8fb5253
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ jobs:

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

Expand Down
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,22 @@
# cocoapods-embed-flutter

[![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)
[![Gem Version](https://badge.fury.io/rb/cocoapods-embed-flutter.svg)](http://badge.fury.io/rb/cocoapods-embed-flutter)
<!--- [![Code Climate](https://codeclimate.com/github/DartBuild/cocoapods-embed-flutter.png)](https://codeclimate.com/github/DartBuild/cocoapods-embed-flutter) -->
[![Code Climate](https://codeclimate.com/github/DartBuild/cocoapods-embed-flutter.png)](https://codeclimate.com/github/DartBuild/cocoapods-embed-flutter)

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

## Installation

### Install using command line.
```bash
$ [sudo] gem install cocoapods-embed-flutter
```

### Or add this to your `Gemfile`.
```rb
gem 'cocoapods-embed-flutter'
```
## Usage

In your host project `Podfile`, write the below line before any target definition
Expand All @@ -33,3 +39,12 @@ pub 'flutter_module', :git => 'https://github.com/gowalla/flutter_module.git', :
pub 'flutter_module', :git => 'https://github.com/gowalla/flutter_module.git', :tag => '0.7.0'
pub 'flutter_module', :git => 'https://github.com/gowalla/flutter_module.git', :commit => '082f8319af'
```

## Links

| Link | Description |
| :----- | :------ |
[Gem page](https://rubygems.org/gems/cocoapods-embed-flutter) | Official Ruby Gems page.
[Code docs](https://www.rubydoc.info/gems/cocoapods-embed-flutter) | Generated code documentation.
[Changelog](https://github.com/DartBuild/cocoapods-embed-flutter/blob/main/CHANGELOG.md) | See the changes introduced in each version.
[Code of Conduct](CODE_OF_CONDUCT.md) | Find out the standards we hold ourselves to.

0 comments on commit 8fb5253

Please sign in to comment.