README.md in quickmox-0.2.0 vs README.md in quickmox-0.2.2
- old
+ new
@@ -1,8 +1,9 @@
[](https://travis-ci.org/jkvalk/quickmox)
[](http://badge.fury.io/rb/quickmox)
[](https://coveralls.io/r/jkvalk/quickmox?branch=master)
+[](https://codeclimate.com/github/jkvalk/quickmox)
# Quickmox
Quickmox is a Ruby gem for managing Proxmox hosts by using SSH screen-scraping techniques.
@@ -26,16 +27,14 @@
```ruby
require 'quickmox'
include Quickmox
-hostname = 'host1.example.com'
-user = 'root'
-pass = 's3cr3t'
+host = Host.new( SSHTransport.new('hostname','username','password') )
+ .connect
+ .scan
-host = Host.new(hostname: hostname, username: user, password: pass).connect
-
p host.localname
p host.uptime
host.guests.each do |guest|
guest.scan
@@ -49,12 +48,10 @@
```
## Development
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/jkvalk/quickmox. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.