Skip to content

Commit 8935bce

Browse files
author
Soumya Mahunt
committed
docs(README): add usage details
1 parent 019d4c5 commit 8935bce

File tree

8 files changed

+117
-34
lines changed

8 files changed

+117
-34
lines changed

‎.gitignore

Lines changed: 59 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@ Thumbs.db
3939
Pods/
4040
contents.xcworkspacedata
4141
IDEWorkspaceChecks.plist
42-
pkg
4342

4443
# Miscellaneous
4544
*.class
@@ -114,4 +113,62 @@ build/
114113
!**/ios/**/default.mode1v3
115114
!**/ios/**/default.mode2v3
116115
!**/ios/**/default.pbxuser
117-
!**/ios/**/default.perspectivev3
116+
!**/ios/**/default.perspectivev3
117+
118+
# Ruby related
119+
*.gem
120+
*.rbc
121+
/.config
122+
/coverage/
123+
/InstalledFiles
124+
/pkg/
125+
/spec/reports/
126+
/spec/examples.txt
127+
/test/tmp/
128+
/test/version_tmp/
129+
/tmp/
130+
131+
# Used by dotenv library to load environment variables.
132+
# .env
133+
134+
# Ignore Byebug command history file.
135+
.byebug_history
136+
137+
## Specific to RubyMotion:
138+
.dat*
139+
.repl_history
140+
build/
141+
*.bridgesupport
142+
build-iPhoneOS/
143+
build-iPhoneSimulator/
144+
145+
## Specific to RubyMotion (use of CocoaPods):
146+
#
147+
# We recommend against adding the Pods directory to your .gitignore. However
148+
# you should judge for yourself, the pros and cons are mentioned at:
149+
# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
150+
#
151+
# vendor/Pods/
152+
153+
## Documentation cache and generated files:
154+
/.yardoc/
155+
/_yardoc/
156+
/doc/
157+
/rdoc/
158+
159+
## Environment normalization:
160+
/.bundle/
161+
/vendor/bundle
162+
/lib/bundler/man/
163+
164+
# for a library or gem, you might want to ignore these files since the code is
165+
# intended to run in multiple environments; otherwise, check them in:
166+
# Gemfile.lock
167+
# .ruby-version
168+
# .ruby-gemset
169+
170+
# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
171+
.rvmrc
172+
173+
# Used by RuboCop. Remote config files pulled in from inherit_from directive.
174+
# .rubocop-https?--*

‎Gemfile.lock

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
PATH
22
remote: .
33
specs:
4-
cocoapods-embed-flutter (0.0.1)
4+
cocoapods-embed-flutter (0.5.0)
55
cocoapods
66
fileutils
77
yaml

‎LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022 DartBuild
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎LICENSE.txt

Lines changed: 0 additions & 22 deletions
This file was deleted.

‎README.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,35 @@
11
# cocoapods-embed-flutter
22

3-
A description of cocoapods-embed-flutter.
3+
[![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+
6+
Straight forward way of declaring flutter modules as dependency for targets, just like cocoapods does with pods.
47

58
## Installation
69

7-
$ gem install cocoapods-embed-flutter
10+
```bash
11+
$ [sudo] gem install cocoapods-embed-flutter
12+
```
813

914
## Usage
1015

11-
$ pod spec flutter POD_NAME
16+
In your host project `Podfile`, write the below line before any target definition
17+
```rb
18+
plugin 'cocoapods-embed-flutter'
19+
```
20+
21+
### Embedding module from a local path.
22+
23+
```rb
24+
pub 'flutter_module', :path => '../'
25+
```
26+
27+
*`:path` can be path pointing to `pubspec.yaml` or to the directory containing `pubspec.yaml` or to the directory containg flutter module.*
28+
29+
### Embedding module from a repository.
30+
31+
```rb
32+
pub 'flutter_module', :git => 'https://github.com/gowalla/flutter_module.git', :branch => 'dev'
33+
pub 'flutter_module', :git => 'https://github.com/gowalla/flutter_module.git', :tag => '0.7.0'
34+
pub 'flutter_module', :git => 'https://github.com/gowalla/flutter_module.git', :commit => '082f8319af'
35+
```

‎cocoapods-embed-flutter.gemspec

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,12 @@ Gem::Specification.new do |spec|
88
spec.version = CocoapodsEmbedFlutter::VERSION
99
spec.authors = ['Soumya Ranjan Mahunt']
1010
spec.email = ['devsoumyamahunt@gmail.com']
11-
spec.description = %q{Embed flutter plugins in iOS projects.}
12-
spec.summary = %q{Embed flutter plugins in iOS projects.}
13-
spec.homepage = 'https://github.com/soumyamahunt/cocoapods-embed-flutter'
11+
spec.description = %q{Embed flutter modules in iOS projects.}
12+
spec.summary = <<-DESC
13+
Straight forward way of declaring flutter modules as dependency for targets,
14+
just like cocoapods does with pods.
15+
DESC
16+
spec.homepage = 'https://github.com/DartBuild/cocoapods-embed-flutter'
1417
spec.license = 'MIT'
1518

1619
spec.files = `git ls-files`.split($/)

‎example/ios_app/Gemfile.lock

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
PATH
22
remote: ../..
33
specs:
4-
cocoapods-embed-flutter (0.0.1)
4+
cocoapods-embed-flutter (0.5.0)
55
cocoapods
66
fileutils
77
yaml
@@ -67,7 +67,7 @@ GEM
6767
ethon (0.15.0)
6868
ffi (>= 1.15.0)
6969
ffi (1.15.5)
70-
fileutils (1.1.0)
70+
fileutils (1.6.0)
7171
fourflusher (2.3.1)
7272
fuzzy_match (2.0.4)
7373
gh_inspector (1.1.3)

‎lib/cocoapods-embed-flutter/gem_version.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
module CocoapodsEmbedFlutter
2-
VERSION = '0.0.1'
2+
VERSION = '0.5.0'.freeze
33
NAME = File.basename(File.dirname(__FILE__))
44
end

0 commit comments

Comments
 (0)