./README.md in p4util-0.0.3 vs ./README.md in p4util-0.1.0
- old
+ new
@@ -1,9 +1,23 @@
-# P4util
+# p4util - common p4 scripting tasks for ruby projects
-TODO: Write a gem description
+When building any kind of tool that uses Perforce underneath, it's pretty common
+to want a few capabilities:
+* Download different versions of p4, p4d, and the C++ API
+* Initialize up a consistent starting environment of p4d
+
+This is a binary script and set of rake tasks that allows this.
+
+
+## Usage
+
+After installation, `p4util help` will list available commands, and
+`p4util help [command]` will list instructions. Some commands, like `p4util init`
+are quite extensive, and should be used as the reference.
+
+
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -16,16 +30,13 @@
Or install it yourself as:
$ gem install p4util
-## Usage
-TODO: Write usage instructions here
+## Changes
-## Contributing
+* 0.1.0: Added `p4util init` command that can do some common p4d configurations,
+ like setting unicode and security settings, along with users and basic
+ adds and edits of files.
-1. Fork it ( https://github.com/[my-github-username]/p4util/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+* 0.0.1-0.0.3: Basic download capabilities
\ No newline at end of file