README.md in aem-deploy-0.1.5 vs README.md in aem-deploy-0.1.6
- old
+ new
@@ -1,13 +1,13 @@
# Aem::Deploy
-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/aem/deploy`. To experiment with that code, run `bin/console` for an interactive prompt.
+Simple Ruby wrapper for the docker compose cli
-TODO: Delete this and the text above, and describe your gem
-
## Installation
+You need to have the docker compose cli installed.
+
Add this line to your application's Gemfile:
```ruby
gem 'aem-deploy'
```
@@ -20,20 +20,32 @@
$ gem install aem-deploy
## Usage
-TODO: Write usage instructions here
+Intialize the object (crx host, user, and pass are required )
-## Development
+ $ client = Aem::Deploy.new({host: '192.168.0.1', user: 'admin', pass: 'admin'})
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Easy Install to CRX (uploads and installs).
-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).
+ $ client.install_package('/Users/meaton/Desktop/centre.zip')
+Upload a package to CRX.
+
+ $ client.upload_package('/Users/meaton/Desktop/centre.zip')
+
+Recompile JSP's
+
+ $ client.recompile_jsps
+
+
+## Development
+
+This project is brand new. I plan to incorporate many other methods here.
## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/aem-deploy.
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/docker_compose_ruby.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).