README.md in fileutils-0.7.2 vs README.md in fileutils-1.0.0

- old
+ new

@@ -1,10 +1,10 @@ -# Fileutils +# FileUtils -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/fileutils`. To experiment with that code, run `bin/console` for an interactive prompt. +[![Build Status](https://travis-ci.org/ruby/fileutils.svg?branch=master)](https://travis-ci.org/ruby/fileutils) -TODO: Delete this and the text above, and describe your gem +Namespace for several file utility methods for copying, moving, removing, etc. ## Installation Add this line to your application's Gemfile: @@ -20,22 +20,25 @@ $ gem install fileutils ## Usage -TODO: Write usage instructions here +Just call `FileUtils` methods. For example: -## Development +```ruby +FileUtils.mkdir("somedir") +# => ["somedir"] -After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. +FileUtils.cd("/usr/bin") +FileUtils.pwd +# => "/usr/bin" +``` -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). +You can find a full method list in the [documentation](https://ruby-doc.org/stdlib/libdoc/fileutils/rdoc/FileUtils.html). ## Contributing Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/fileutils. - ## License -The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). - +The gem is available as open source under the terms of the [2-Clause BSD License](https://opensource.org/licenses/BSD-2-Clause).