diff --git a/README.md b/README.md index f5b0afe..cc5b5cb 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,6 @@ # AdbExtended -Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/adb_extended`. To experiment with that code, run `bin/console` for an interactive prompt. - -TODO: Delete this and the text above, and describe your gem +A wrapper around `adb` to handle working with more than 1 device plugged in at a time ## Installation @@ -22,7 +20,16 @@ Or install it yourself as: ## Usage -TODO: Write usage instructions here +This is intended as a commandline application. The options are as follows: + +- adb_extended ashell # Lists the devices and allows you to choose one to run the shell on +- adb_extended devices # Lists the Android devices with a little more info +- adb_extended help [COMMAND] # Describe available commands or one specific command +- adb_extended install PATH # Installs the provided apk on the selected device +- adb_extended logcat PACKAGE # Lists the devices and allows you to choose one to run with logcat +- adb_extended pidcat PACKAGE # Lists the devices and allows you to choose one to run with pidcat (requires `pidcat` to be installed and available in the path) +- adb_extended uninstall PACKAGE # Uninstalls the provided package on the selected device + ## Development @@ -32,7 +39,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To ## Contributing -Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/adb_extended. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. +Bug reports and pull requests are welcome on GitHub at https://github.com/daentech/adb_extended. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. ## License @@ -40,4 +47,4 @@ The gem is available as open source under the terms of the [MIT License](https:/ ## Code of Conduct -Everyone interacting in the AdbExtended project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/adb_extended/blob/master/CODE_OF_CONDUCT.md). +Everyone interacting in the AdbExtended project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/daentech/adb_extended/blob/master/CODE_OF_CONDUCT.md). diff --git a/adb_extended.gemspec b/adb_extended.gemspec index 7382469..aabef52 100644 --- a/adb_extended.gemspec +++ b/adb_extended.gemspec @@ -13,15 +13,6 @@ Gem::Specification.new do |spec| spec.homepage = "https://github.com/daentech/adb_extended" spec.license = "MIT" - # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host' - # to allow pushing to a single host or delete this section to allow pushing to any host. - if spec.respond_to?(:metadata) - spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'" - else - raise "RubyGems 2.0 or newer is required to protect against " \ - "public gem pushes." - end - # Specify which files should be added to the gem when it is released. # The `git ls-files -z` loads the files in the RubyGem that have been added into git. spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do