Skip to content

Commit

Permalink
Merge pull request #15 from chef/examples
Browse files Browse the repository at this point in the history
Fix the examples to actually work
  • Loading branch information
thommay authored Feb 21, 2018
2 parents 3652fc3 + 7a63914 commit aea48e9
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Mixlib::Archive

[![Build Status Master](https://travis-ci.org/chef/mixlib-archive.svg?branch=master)](https://travis-ci.org/chef/mixlib-archive) [![Gem Version](https://badge.fury.io/rb/mixlib-archive.svg)](https://badge.fury.io/rb/mixlib-archive)

A very simple gem to extract archives.
Expand Down Expand Up @@ -29,15 +30,15 @@ To extract an archive

```ruby
require "mixlib/archive"
tar = Mixlib::Artifact.new("/path/to/tar")
tar = Mixlib::Archive.new("/path/to/tar")
tar.extract("/destination/directory")
```

To create an archive

```ruby
require "mixlib/archive"
tar = Mixlib::Artifact.new("/path/to/foo.tar.gz")
tar = Mixlib::Archive.new("/path/to/foo.tar.gz")
tar.create(%w{ file.rb file2.rb }, gzip: true)
```

Expand All @@ -47,8 +48,7 @@ After checking out the repo, run `bundle` to install dependencies. Then, run `bu

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/chef/mixlib-archive. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Community Guidelines](https://docs.chef.io/community_guidelines.html) code of conduct.

Bug reports and pull requests are welcome on GitHub at <https://github.com/chef/mixlib-archive>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Community Guidelines](https://docs.chef.io/community_guidelines.html) code of conduct.

## License

Expand Down

0 comments on commit aea48e9

Please # to comment.