From 52852aed76005285a8059bd1adb580a169d7463f Mon Sep 17 00:00:00 2001 From: Soumya Ranjan Mahunt Date: Tue, 8 Mar 2022 10:02:44 +0530 Subject: [PATCH] docs(README): add usage details --- .gitignore | 61 +++++++++++++++++++++- Gemfile.lock | 2 +- LICENSE | 21 ++++++++ LICENSE.txt | 22 -------- README.md | 30 +++++++++-- cocoapods-embed-flutter.gemspec | 9 ++-- example/ios_app/Gemfile.lock | 4 +- lib/cocoapods-embed-flutter/gem_version.rb | 2 +- 8 files changed, 117 insertions(+), 34 deletions(-) create mode 100644 LICENSE delete mode 100644 LICENSE.txt diff --git a/.gitignore b/.gitignore index 6577156..e66465d 100644 --- a/.gitignore +++ b/.gitignore @@ -39,7 +39,6 @@ Thumbs.db Pods/ contents.xcworkspacedata IDEWorkspaceChecks.plist -pkg # Miscellaneous *.class @@ -114,4 +113,62 @@ build/ !**/ios/**/default.mode1v3 !**/ios/**/default.mode2v3 !**/ios/**/default.pbxuser -!**/ios/**/default.perspectivev3 \ No newline at end of file +!**/ios/**/default.perspectivev3 + +# Ruby related +*.gem +*.rbc +/.config +/coverage/ +/InstalledFiles +/pkg/ +/spec/reports/ +/spec/examples.txt +/test/tmp/ +/test/version_tmp/ +/tmp/ + +# Used by dotenv library to load environment variables. +# .env + +# Ignore Byebug command history file. +.byebug_history + +## Specific to RubyMotion: +.dat* +.repl_history +build/ +*.bridgesupport +build-iPhoneOS/ +build-iPhoneSimulator/ + +## Specific to RubyMotion (use of CocoaPods): +# +# We recommend against adding the Pods directory to your .gitignore. However +# you should judge for yourself, the pros and cons are mentioned at: +# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control +# +# vendor/Pods/ + +## Documentation cache and generated files: +/.yardoc/ +/_yardoc/ +/doc/ +/rdoc/ + +## Environment normalization: +/.bundle/ +/vendor/bundle +/lib/bundler/man/ + +# for a library or gem, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# Gemfile.lock +# .ruby-version +# .ruby-gemset + +# unless supporting rvm < 1.11.0 or doing something fancy, ignore this: +.rvmrc + +# Used by RuboCop. Remote config files pulled in from inherit_from directive. +# .rubocop-https?--* \ No newline at end of file diff --git a/Gemfile.lock b/Gemfile.lock index 22bb526..8f4a3b9 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,7 +1,7 @@ PATH remote: . specs: - cocoapods-embed-flutter (0.0.1) + cocoapods-embed-flutter (0.5.0) cocoapods fileutils yaml diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..7b18921 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2022 DartBuild + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/LICENSE.txt b/LICENSE.txt deleted file mode 100644 index 7cd9747..0000000 --- a/LICENSE.txt +++ /dev/null @@ -1,22 +0,0 @@ -Copyright (c) 2022 Soumya Mahunt - -MIT License - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md index d005d43..30d0775 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,35 @@ # cocoapods-embed-flutter -A description of cocoapods-embed-flutter. +[![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) + +Straight forward way of declaring flutter modules as dependency for targets, just like cocoapods does with pods. ## Installation - $ gem install cocoapods-embed-flutter +```bash +$ [sudo] gem install cocoapods-embed-flutter +``` ## Usage - $ pod spec flutter POD_NAME +In your host project `Podfile`, write the below line before any target definition +```rb +plugin 'cocoapods-embed-flutter' +``` + +### Embedding module from a local path. + +```rb +pub 'flutter_module', :path => '../' +``` + +*`:path` can be path pointing to `pubspec.yaml` or to the directory containing `pubspec.yaml` or to the directory containg flutter module.* + +### Embedding module from a repository. + +```rb +pub 'flutter_module', :git => 'https://github.com/gowalla/flutter_module.git', :branch => 'dev' +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' +``` diff --git a/cocoapods-embed-flutter.gemspec b/cocoapods-embed-flutter.gemspec index f1c6fb6..a15e07c 100644 --- a/cocoapods-embed-flutter.gemspec +++ b/cocoapods-embed-flutter.gemspec @@ -8,9 +8,12 @@ Gem::Specification.new do |spec| spec.version = CocoapodsEmbedFlutter::VERSION spec.authors = ['Soumya Ranjan Mahunt'] spec.email = ['devsoumyamahunt@gmail.com'] - spec.description = %q{Embed flutter plugins in iOS projects.} - spec.summary = %q{Embed flutter plugins in iOS projects.} - spec.homepage = 'https://github.com/soumyamahunt/cocoapods-embed-flutter' + spec.description = %q{Embed flutter modules in iOS projects.} + spec.summary = <<-DESC + Straight forward way of declaring flutter modules as dependency for targets, + just like cocoapods does with pods. + DESC + spec.homepage = 'https://github.com/DartBuild/cocoapods-embed-flutter' spec.license = 'MIT' spec.files = `git ls-files`.split($/) diff --git a/example/ios_app/Gemfile.lock b/example/ios_app/Gemfile.lock index 47819d6..f51ee83 100644 --- a/example/ios_app/Gemfile.lock +++ b/example/ios_app/Gemfile.lock @@ -1,7 +1,7 @@ PATH remote: ../.. specs: - cocoapods-embed-flutter (0.0.1) + cocoapods-embed-flutter (0.5.0) cocoapods fileutils yaml @@ -67,7 +67,7 @@ GEM ethon (0.15.0) ffi (>= 1.15.0) ffi (1.15.5) - fileutils (1.1.0) + fileutils (1.6.0) fourflusher (2.3.1) fuzzy_match (2.0.4) gh_inspector (1.1.3) diff --git a/lib/cocoapods-embed-flutter/gem_version.rb b/lib/cocoapods-embed-flutter/gem_version.rb index 4f45824..2e81610 100644 --- a/lib/cocoapods-embed-flutter/gem_version.rb +++ b/lib/cocoapods-embed-flutter/gem_version.rb @@ -1,4 +1,4 @@ module CocoapodsEmbedFlutter - VERSION = '0.0.1' + VERSION = '0.5.0'.freeze NAME = File.basename(File.dirname(__FILE__)) end