Skip to content

Commit

Permalink
Update README and allow publishing
Browse files Browse the repository at this point in the history
  • Loading branch information
daentech committed Oct 1, 2018
1 parent 34a4264 commit ac50fc1
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 15 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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

Expand All @@ -32,12 +39,12 @@ 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

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## 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).
9 changes: 0 additions & 9 deletions adb_extended.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit ac50fc1

Please sign in to comment.